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 expiresInDays is omitted, the link expires after 360 days.

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

apiKeyNamestringOptional

An optional name for the generated API key, for easier identification in the BI.P.EYE dashboard

Example: My Product Embed Key

expiresInDaysintegerOptional

How long the link is valid in days. Defaults to 360 days if omitted.

Default: 360Example: 30

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-timeRequiredExample: 2025-01-01T12:00:00.000Z

apiKeystring · uuidRequired

The embed API key. Pass this to the PATCH /embed/apiKey endpoint to update the key later.

Example: d9e8f7a6-b5c4-3210-fedc-ba9876543210

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: 324

{
  "organizationId": "422930fe-bdc7-4324-991d-b68193a173bb",
  "dashboardId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "apiKeyName": "My Product Embed Key",
  "expiresInDays": 30,
  "overrideCurrency": "USD",
  "restrictDatasetsData": {
    "c3dcb641-72fe-458b-9fe5-1594ba69aff4": {
      "filters": [
        {
          "jsonPath": "$.accountId",
          "type": "is",
          "value": "ac_123"
        }
      ]
    }
  }
}

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

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": "$.accountId",
          "type": "string"
        }
      ]
    }
  ]
}

Delete an embed API key

delete

Permanently deletes an embed API key.

Once deleted, any iframe using this key will immediately lose access to the dashboard. This action cannot be undone.

Authorizations

organizationApiKey

X-API-KeystringRequired

Your organization API key

Body

application/json

organizationIdstring · uuidRequired

The organization ID that owns the API key

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

dashboardIdstring · uuidRequired

The dashboard ID that the API key belongs to

Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890

apiKeystring · uuidRequired

The embed API key to delete

Example: d9e8f7a6-b5c4-3210-fedc-ba9876543210

Responses

200

API key deleted successfully

application/json

messagestringRequiredExample: API key deleted successfully

400

Validation error — check your request body

401

Invalid or missing API key

404

API key not found or does not belong to your organization

delete

/embed/apiKey

HTTPcURLJavaScriptPython

DELETE /v1/embed/apiKey HTTP/1.1
Host: api.bipeye.com
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 158

{
  "organizationId": "422930fe-bdc7-4324-991d-b68193a173bb",
  "dashboardId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "apiKey": "d9e8f7a6-b5c4-3210-fedc-ba9876543210"
}

{
  "message": "API key deleted successfully"
}

Edit an existing embed API key

patch

Updates the configuration of an existing embed API key.

You can update the expiry duration and/or the per-dataset row-level filters. Only the fields you provide will be changed — omitted fields are left as-is. If expiresInDays is omitted, expiry is reset to the default of 360 days from now.

Authorizations

organizationApiKey

X-API-KeystringRequired

Your organization API key

Body

application/json

organizationIdstring · uuidRequired

The organization ID that owns the API key

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

dashboardIdstring · uuidRequired

The dashboard ID that the API key belongs to

Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890

apiKeyNamestringOptional

An optional name for the generated API key, for easier identification in the BI.P.EYE dashboard

Example: My Product Embed Key

apiKeystring · uuidRequired

The embed API key to edit

Example: d9e8f7a6-b5c4-3210-fedc-ba9876543210

expiresInDaysintegerOptional

New expiry duration in days from now. Defaults to 360 days if omitted.

Example: 30

Responses

200

API key updated successfully

application/json

messagestringRequiredExample: API key updated successfully

400

Validation error — check your request body

401

Invalid or missing API key

404

API key not found or does not belong to your organization

patch

/embed/apiKey

HTTPcURLJavaScriptPython

PATCH /v1/embed/apiKey HTTP/1.1
Host: api.bipeye.com
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 347

{
  "organizationId": "422930fe-bdc7-4324-991d-b68193a173bb",
  "dashboardId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "apiKeyName": "My Product Embed Key",
  "apiKey": "d9e8f7a6-b5c4-3210-fedc-ba9876543210",
  "expiresInDays": 30,
  "restrictDatasetsData": {
    "c3dcb641-72fe-458b-9fe5-1594ba69aff4": {
      "filters": [
        {
          "jsonPath": "$.accountId",
          "type": "is",
          "value": "ac_123"
        }
      ]
    }
  }
}

{
  "message": "API key updated successfully"
}