Skip to main content
curl --request GET \
  --url 'https://api.usedatabrain.com/api/v2/data-app' \
  --header 'Authorization: Bearer service_token_xyz...'

{
  "data": [
    {
      "name": "Customer Portal Analytics",
      "type": "embedded",
      "createdAt": "2024-01-15T10:30:00Z",
      "updatedAt": "2024-01-20T14:45:00Z",
      "embedCount": 3,
      "embeds": [
        {
          "name": "Sales Dashboard Embed",
          "embedId": "sales-dashboard-123",
          "createdAt": "2024-01-15T11:00:00Z",
          "updatedAt": "2024-01-18T09:30:00Z"
        },
        {
          "name": "Revenue Metrics Embed",
          "embedId": "revenue-metrics-456",
          "createdAt": "2024-01-16T14:15:00Z",
          "updatedAt": "2024-01-19T16:00:00Z"
        },
        {
          "name": "Customer Overview",
          "embedId": "customer-overview-789",
          "createdAt": "2024-01-17T08:45:00Z",
          "updatedAt": "2024-01-20T11:20:00Z"
        }
      ]
    },
    {
      "name": "Partner Dashboard",
      "type": "embedded",
      "createdAt": "2024-01-10T09:00:00Z",
      "updatedAt": "2024-01-15T12:30:00Z",
      "embedCount": 1,
      "embeds": [
        {
          "name": "Partner Analytics",
          "embedId": "partner-analytics-001",
          "createdAt": "2024-01-10T10:00:00Z",
          "updatedAt": "2024-01-15T12:30:00Z"
        }
      ]
    }
  ]
}
GET
/
api
/
v2
/
data-app
curl --request GET \
  --url 'https://api.usedatabrain.com/api/v2/data-app' \
  --header 'Authorization: Bearer service_token_xyz...'

{
  "data": [
    {
      "name": "Customer Portal Analytics",
      "type": "embedded",
      "createdAt": "2024-01-15T10:30:00Z",
      "updatedAt": "2024-01-20T14:45:00Z",
      "embedCount": 3,
      "embeds": [
        {
          "name": "Sales Dashboard Embed",
          "embedId": "sales-dashboard-123",
          "createdAt": "2024-01-15T11:00:00Z",
          "updatedAt": "2024-01-18T09:30:00Z"
        },
        {
          "name": "Revenue Metrics Embed",
          "embedId": "revenue-metrics-456",
          "createdAt": "2024-01-16T14:15:00Z",
          "updatedAt": "2024-01-19T16:00:00Z"
        },
        {
          "name": "Customer Overview",
          "embedId": "customer-overview-789",
          "createdAt": "2024-01-17T08:45:00Z",
          "updatedAt": "2024-01-20T11:20:00Z"
        }
      ]
    },
    {
      "name": "Partner Dashboard",
      "type": "embedded",
      "createdAt": "2024-01-10T09:00:00Z",
      "updatedAt": "2024-01-15T12:30:00Z",
      "embedCount": 1,
      "embeds": [
        {
          "name": "Partner Analytics",
          "embedId": "partner-analytics-001",
          "createdAt": "2024-01-10T10:00:00Z",
          "updatedAt": "2024-01-15T12:30:00Z"
        }
      ]
    }
  ]
}
Get a comprehensive list of all Data Apps in your organization, including their embed configurations, creation timestamps, and embed counts.
This endpoint returns all Data Apps of type “embedded” in your organization. Each Data App includes summary information about its associated embeds.
Authentication Requirement: This endpoint requires a service token (not a data app API key). Service tokens have elevated permissions to manage Data Apps across your organization.

​
Endpoint Formats

​
Authentication

This endpoint requires a service token in the Authorization header. Service tokens differ from data app API keys and provide organization-level permissions. To access your service token:
  1. In Settings page, navigate to the Service Tokens section.
  2. Click the “Generate Token” button to create a new service token if you don’t have one already.
Use this token as the Bearer value in your Authorization header.

​
Headers

​
Authorization
string
required
Bearer token for API authentication. Use your service token (not data app API key).
Authorization: Bearer service_token_xyz...

​
Query Parameters

​
isPagination
string
Whether to paginate results. Pass "true" to enable pagination with a limit of 10 per page.Note: Query parameters are passed as strings. Use "true" or "false".
​
pageNumber
string
Page number to retrieve (1-based). Only used when isPagination is "true". Must be a numeric string (e.g., "1", "2").

​
Response

​
data
array
Array of Data App objects with their configuration details.
​
data[].name
string
The name of the Data App.
​
data[].type
string
The type of the Data App. Currently always "embedded".
​
data[].createdAt
string
ISO 8601 formatted timestamp indicating when the Data App was created.
​
data[].updatedAt
string
ISO 8601 formatted timestamp indicating when the Data App was last updated.
​
data[].embedCount
number
The total number of embed configurations associated with this Data App.
​
data[].embeds
array
Array of embed configurations associated with this Data App.
​
error
object
Error object returned only when the request fails. Not included in successful responses.

​
Examples

​
HTTP Status Code Summary

Status CodeDescription
200OK - Data Apps retrieved successfully
400Bad Request - Invalid request parameters
500Internal Server Error - Server error occurred

​
Possible Errors

Error CodeHTTP StatusDescription
AUTHENTICATION_ERROR400Invalid or missing service token
INTERNAL_SERVER_ERROR500Server error

​
Quick Start Guide

1

Get your service token

In Settings page, navigate to the Service Tokens section. Click the “Generate Token” button to create a new service token if you don’t have one already.
2

List all Data Apps

Make a GET request to retrieve all Data Apps:
curl --request GET \
  --url 'https://api.usedatabrain.com/api/v2/data-app' \
  --header 'Authorization: Bearer service_token_xyz...'
3

Use pagination for large lists

If you have many Data Apps, use pagination:
curl --request GET \
  --url 'https://api.usedatabrain.com/api/v2/data-app?isPagination=true&pageNumber=1' \
  --header 'Authorization: Bearer service_token_xyz...'
4

Process the results

Use the response to manage your Data Apps:
const dataApps = await listDataApps();

dataApps.data.forEach(app => {
  console.log(`Data App: ${app.name}`);
  console.log(`  Type: ${app.type}`);
  console.log(`  Embeds: ${app.embedCount}`);
  console.log(`  Created: ${app.createdAt}`);
  
  app.embeds.forEach(embed => {
    console.log(`    - ${embed.name} (${embed.embedId})`);
  });
});

​
Next Steps

Create Data App

Create new Data Apps for your organization

Delete Data App

Remove Data Apps you no longer need

Create API Token

Generate API tokens for your Data Apps

List API Tokens

View API tokens for a specific Data App