Getting Data In

Can I get the iframe embed URL for a report via the REST API?

sjodle
Path Finder

I'm hoping to build a product that allows users to easily select a report from their Splunk instance and embed it in a page. Is it possible to either retrieve or generate the iframe embed URL for a report from the REST API? Optionally, can I enable embedding for a report through the REST API?

0 Karma
1 Solution

sjodle
Path Finder

Turns out the answer is yes to both.

For a report that's already set up for embedding, the URL scheme is http://<host>:8000/embed?s=/servicesNS/<owner>/<app>/saved/searches/<search name>&oid=<token>. The "token" is retrievable via the "embed.token" attribute of the scheduled search, visible in the REST API.

To enable embedding of a report, assuming it's already been scheduled, simply POST to https://<host>:8089/servicesNS/<owner>/<app>/saved/searches/<search name>/embed.

View solution in original post

andygerberkp
Explorer

I don't believe this is correct anymore for current releases of Splunk.  The embed URL has changed drastically.

0 Karma

sjodle
Path Finder

Turns out the answer is yes to both.

For a report that's already set up for embedding, the URL scheme is http://<host>:8000/embed?s=/servicesNS/<owner>/<app>/saved/searches/<search name>&oid=<token>. The "token" is retrievable via the "embed.token" attribute of the scheduled search, visible in the REST API.

To enable embedding of a report, assuming it's already been scheduled, simply POST to https://<host>:8089/servicesNS/<owner>/<app>/saved/searches/<search name>/embed.

Got questions? Get answers!

Join the Splunk Community Slack to learn, troubleshoot, and make connections with fellow Splunk practitioners in real time!

Meet up IRL or virtually!

Join Splunk User Groups to connect and learn in-person by region or remotely by topic or industry.

Get Updates on the Splunk Community!

Quantify Your Splunk Investment Impact: Introducing Savings Metrics to Value Insights

Building on the foundation established in our initial Value Insights releases, we are introducing the Savings ...

Event Series: Telemetry Pipeline Management

Balancing Scale and Spend: Gaining Control Over High-Volume Metrics in Splunk Observability Cloud As ...

Kick the Tires Before You Commit: A Hands-On Tour of the Splunk Observability Cloud ...

Evaluating an enterprise observability platform usually goes like this: fill out a form, get a free trial with ...