Finding more endpoints
These docs cover the endpoints that matter for embedding and provisioning. The full Yurbi API mirrors every action in the product — here's how to find the rest.
What's documented here
This reference focuses on the calls a software vendor actually needs: authenticating users, provisioning them (users, groups, roles, AppShield policies), discovering content, and rendering or embedding it. That's the stable, supported core.
Behind the scenes, Yurbi exposes an API for every action in the interface — building reports, designing dashboards, scheduling delivery, managing data sources, and more. Those calls exist, but most aren't part of a typical embed/provision integration, so they're not documented here.
How to discover any endpoint
If you need to automate something you can do in the Yurbi UI, you can see exactly which call it makes using your browser's developer tools:
- Open Yurbi in your browser and sign in.
- Open DevTools (F12, or right-click → Inspect) and select the Network tab.
- Filter to Fetch/XHR.
- Perform the action in the Yurbi UI (e.g. favorite a report, save a dashboard).
- Click the
/api/...request that appears. The Payload/Request tab shows the URL and JSON body; the Response tab shows what comes back. - Replicate that request from your own code, passing your
sessionTokenin the body.
Everything you find follows the same conventions: POST + JSON,
sessionToken in the body, the ErrorCode / ErrorMessage envelope, and the
read-modify-write pattern for Save* calls.
A caveat — and an offer
Undocumented endpoints are internal: they can change between versions without notice, and their request/response shapes aren't guaranteed. The endpoints in this reference are the ones we intend to keep stable for integrators.
If you find a call you'd like us to document and support, tell us what you're trying to accomplish — we're happy to help, and to add it here if it fits the embedding/provisioning story.