Export API

Authentication

To authenticate with the Export API, you need to use your clientId and clientSecret. Make sure your client has read or root mode. The default client does not have access to the Export API.

We expect you to send openpanel-client-id and openpanel-client-secret headers with your requests.

Example:

curl 'https://api.openpanel.dev/export/events' \
  -H 'openpanel-client-id: YOUR_CLIENT_ID' \
  -H 'openpanel-client-secret: YOUR_CLIENT_SECRET'

Events

Get events from a specific project within a date range.

Endpoint: GET /export/events

Parameters:

project_id (required): The ID of the project
event (optional): Filter by event name(s). Can be a single event or an array of events.
start (optional): Start date (format: YYYY-MM-DD)
end (optional): End date (format: YYYY-MM-DD)
page (optional, default: 1): Page number for pagination
limit (optional, default: 50, max: 50): Number of events per page
includes (optional): Additional fields to include in the response

Example:

curl 'https://api.openpanel.dev/export/events?project_id=abc&event=screen_view&start=2024-04-15&end=2024-04-18' \
  -H 'openpanel-client-id: YOUR_CLIENT_ID' \
  -H 'openpanel-client-secret: YOUR_CLIENT_SECRET'

Profiles

During development

API Beta to v1