Skip to main content
GET
Get a list of scheduled email reports associated with a specific embed configuration. This endpoint allows you to retrieve all scheduled reports for an embed, with optional filtering by client ID or user identifier, and supports pagination for large result sets.
This endpoint returns scheduled email reports that have been configured for the specified embed. Reports are filtered based on the embed’s data app and can be further filtered by client ID or user identifier.

Authentication

All API requests must include your API key in the Authorization header. Get your API token when creating a data app - see our data app creation guide for details. Finding your API token: For detailed instructions, see the API Token guide.

Headers

string
required
Bearer token for API authentication. Use your API key from the data app.

Query Parameters

string
required
The embed configuration ID to fetch scheduled reports for. This identifies which embedded dashboard’s scheduled reports you want to retrieve.
string
Optional client identifier for filtering reports. When provided, only returns scheduled reports associated with the specified client.
string
Enable pagination to limit the number of results returned. Pass "true" to enable pagination with a limit of 10 reports per page.Note: Query parameters are passed as strings. Use "true" or "false".
string
Page number for pagination (1-based). Only used when isPagination is "true". Must be a numeric string (e.g., "1", "2").Default: If pagination is enabled and pageNumber is not provided, defaults to page 1.
string
Filter reports by the user identifier who created them. When provided, only returns scheduled reports created by the specified user.

Response

array
Array of scheduled email report objects for the specified embed.
string
Unique identifier for the scheduled email report.
string
The subject line of the scheduled email report.
array
Array of charts/metrics included in this scheduled report.
string
The unique identifier of the metric included in the report.
object
Configuration object defining when and how often the report is scheduled to be sent.
string
ISO 8601 timestamp indicating when the scheduled report was created.
string
ISO 8601 timestamp indicating when the scheduled report was last updated.
string
The client identifier associated with this scheduled report. This is extracted from the guest token used when creating the report.
string
The embed configuration ID this scheduled report is associated with.
string | null
The identifier of the user who created this scheduled report, or null if not specified.
  • Non-null value: Indicates a user-created scheduled report with the creator’s identifier
  • null: Indicates a system-created or admin-created scheduled report
object
Error object returned only when the request fails. Not present in successful responses.

Examples

HTTP Status Code Summary

Possible Errors

Filtering and Pagination

Client Filtering

When clientId is provided, the API returns only scheduled reports associated with that specific client:

User Filtering

When userIdentifier is provided, the API returns only scheduled reports created by that user:

Combined Filtering

You can combine clientId and userIdentifier to filter reports by both client and creator:

Pagination

When pagination is enabled, results are limited to 10 reports per page:

Use Cases

1. Display Scheduled Reports in Dashboard

Show all scheduled reports configured for an embed in your application’s settings page:

2. Client-Specific Report Management

Allow clients to view and manage only their own scheduled reports:

3. User-Specific Report View

Show users only the reports they created: