Export

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.

Include the following headers with your requests:

• openpanel-client-id: Your OpenPanel client ID
• openpanel-client-secret: Your OpenPanel client secret

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'

Query Parameters

Example Request

curl 'https://api.openpanel.dev/export/events?project_id=abc123&event=screen_view&start=2024-04-15&end=2024-04-18&page=1&limit=50&includes=profile,meta' \
  -H 'openpanel-client-id: YOUR_CLIENT_ID' \
  -H 'openpanel-client-secret: YOUR_CLIENT_SECRET'

Response

{
  "meta": {
    "count": number,
    "totalCount": number,
    "pages": number,
    "current": number
  },
  "data": Array<Event>
}

Charts

Retrieve chart data for a specific project.

Endpoint

GET /export/charts

Query Parameters

Events configuration

Each event configuration object has the following properties:

Filter Configuration

Each filter in the filters array has the following structure:

Example event configuration:

{
  "name": "purchase",
  "segment": "user",
  "filters": [
    {
      "name": "total",
      "operator": "is",
      "value": ["100"]
    }
  ]
}

The operators are used in the SQL builder (chart.service.ts lines 262-346) with the following mappings:

• is: Equals comparison
• isNot: Not equals comparison
• contains: LIKE %value%
• doesNotContain: NOT LIKE %value%
• startsWith: LIKE value%
• endsWith: LIKE %value
• regex: Match function

Example Request

curl 'https://api.openpanel.dev/export/charts?projectId=abc123&events=[{"name":"screen_view"}]&interval=day&range=last_30_days&chartType=linear&metric=sum' \
  -H 'openpanel-client-id: YOUR_CLIENT_ID' \
  -H 'openpanel-client-secret: YOUR_CLIENT_SECRET'

Response

The response will include chart data with series, metrics, and optional previous period comparisons based on the input parameters.

Funnel

Retrieve funnel data for a specific project.

Endpoint

GET /export/funnel

Query Parameters

Example Request

curl 'https://api.openpanel.dev/export/funnel?projectId=abc123&events=[{"name":"sign_up"},{"name":"purchase"}]&range=last_30_days' \
  -H 'openpanel-client-id: YOUR_CLIENT_ID' \
  -H 'openpanel-client-secret: YOUR_CLIENT_SECRET'

Response

The response will include funnel data with total sessions and step-by-step breakdown of the funnel progression.

{
  "totalSessions": number,
  "steps": [
    {
      "event": {
        "name": string,
        "displayName": string
      },
      "count": number,
      "percent": number,
      "dropoffCount": number,
      "dropoffPercent": number,
      "previousCount": number
    }
  ]
}

Notes

• All date parameters should be in ISO format (YYYY-MM-DD).
• The range parameter accepts values like today, yesterday, last_7_days, last_30_days, this_month, last_month, this_year, last_year, all_time.
• The interval parameter accepts values like minute, hour, day, month.
• The chartType parameter can be linear or other supported chart types.
• The metric parameter can be sum, average, min, or max.

Remember to replace YOUR_CLIENT_ID and YOUR_CLIENT_SECRET with your actual OpenPanel API credentials.