API Reference

Generate a signed embed URL

post

Creates a signed URL that embeds a dashboard inside your product.

Pass the returned url directly to an <iframe src="..."> in your frontend. If expiresInSeconds is set, the link becomes invalid after that duration.

Authorizations

organizationApiKey

X-API-KeystringRequired

Your organization API key

Body

application/json

organizationIdstring · uuidRequired

The organization ID to embed

Example: 422930fe-bdc7-4324-991d-b68193a173bb

dashboardIdstring · uuidRequired

The dashboard ID to embed

Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890

expiresInSecondsintegerOptional

How long the link is valid in seconds. Omit for non-expiring links.

Default: 3600Example: 3600

overrideCurrencystring · enumOptional

Override the currency symbol displayed across all charts in the dashboard. Accepts either the ISO currency code (USD) or the symbol ($) — both resolve to the same currency.

Example: USDPossible values:

Responses

200

Signed embed URL

application/json

urlstring · uriRequiredExample: https://bipeye.com/embed/organizations/org_123/dashboards/dash_456?apiKey=...

expiresAtstring · date-time · nullableRequiredExample: 2025-01-01T12:00:00.000Z

400

Validation error — check your request body

401

Invalid or missing API key

404

Dashboard not found or does not belong to your organization

post

/embed/link

HTTPcURLJavaScriptPython

POST /v1/embed/link HTTP/1.1
Host: api.bipeye.com
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 286

{
  "organizationId": "422930fe-bdc7-4324-991d-b68193a173bb",
  "dashboardId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "expiresInSeconds": 3600,
  "overrideCurrency": "USD",
  "restrictDatasetsData": {
    "c3dcb641-72fe-458b-9fe5-1594ba69aff4": {
      "filters": [
        {
          "jsonPath": "$.region",
          "type": "is",
          "value": "EU"
        }
      ]
    }
  }
}

{
  "url": "https://bipeye.com/embed/organizations/org_123/dashboards/dash_456?apiKey=...",
  "expiresAt": "2025-01-01T12:00:00.000Z"
}

List datasets for a dashboard

post

Returns all datasets used by the given dashboard, along with their fields and inferred types.

Use this to discover which jsonPath values and field types are available when building restrictDatasetsData filters for the embed link endpoint.

Authorizations

organizationApiKey

X-API-KeystringRequired

Your organization API key

Body

application/json

organizationIdstring · uuidRequired

The organization ID

Example: 422930fe-bdc7-4324-991d-b68193a173bb

dashboardIdstring · uuidRequired

The dashboard ID to fetch datasets for

Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890

Responses

200

List of datasets with their fields

application/json

400

Validation error — check your request body

401

Invalid or missing API key

404

Dashboard not found or does not belong to your organization

post

/dashboards/datasets

HTTPcURLJavaScriptPython

POST /v1/dashboards/datasets HTTP/1.1
Host: api.bipeye.com
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 110

{
  "organizationId": "422930fe-bdc7-4324-991d-b68193a173bb",
  "dashboardId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

{
  "datasets": [
    {
      "datasetId": "c3dcb641-72fe-458b-9fe5-1594ba69aff4",
      "fields": [
        {
          "jsonPath": "$.region",
          "type": "string"
        }
      ]
    }
  ]
}