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!

From Data to Insight: Announcing the Winners of the Splunk Dashboard Contest

Hi Splunkers, First off, thank you to everyone who participated in our very first From Data to Insight: The ...

Splunk Developers: Construct Your Future at the .conf26 Builder Bar

Calling all Splunk architects, platform admins, and app developers: the site is open, and the blueprints are ...

Quick connection discovery mode for forwarders

When a Splunk forwarder loses connectivity to its indexers, it does not always reconnect immediately. In many ...