Create Event Export

​

Overview

​

Request Body

​

Required Parameters

​

Optional Parameters

​

Response

​

Success Response (202 Accepted)

​

Error Response

​

Export File Format

{"id":123,"event_name":"purchase","amount":99.99,"event_time_utc":"2024-01-15T10:23:45Z"}
{"id":124,"event_name":"sign_up","amount":0,"event_time_utc":"2024-01-15T10:24:12Z"}
{"id":125,"event_name":"purchase","amount":149.50,"event_time_utc":"2024-01-15T10:25:33Z"}

​

Example Requests

# Create export for a single day with minimal parameters
curl -X POST "https://app.cometly.com/public-api/v1/events/exports" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "date": "2024-01-15"
  }'

# Create export with event filtering and specific fields
curl -X POST "https://app.cometly.com/public-api/v1/events/exports" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "date": "2024-01-15",
    "query_mode": "profile",
    "event_names": ["purchase", "sign_up"],
    "fields": ["id", "event_name", "amount", "profile_id", "event_time_utc"]
  }'

# Create export with attribution filtering
curl -X POST "https://app.cometly.com/public-api/v1/events/exports" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "date": "2024-01-15",
    "sources": ["facebook_ads", "google_ads"],
    "attribution_model": "last_touch",
    "attribution_window": 30,
    "fields": ["id", "event_name", "amount", "ad_id", "event_time_utc"]
  }'

​

Status Codes

​

Next Steps

​

Notes

• Rate Limit: This endpoint has a limit of 5 requests per minute per Space. See Rate Limiting for details.
• Processing Time: Exports typically complete within seconds to a few minutes depending on data volume
• Max Date Range: Each export can only contain one day of data (00:00:00 to 23:59:59 in your space’s timezone)
• Export Capacity: Can handle 100,000+ events per day efficiently
• Status Checking: Use the Get Event Export endpoint to check status (30 requests/min limit)
• Attribution Breakdown: With multi-touch attribution models (linear, u_shaped, linear_paid), each event may generate multiple rows in the export - one per attributed touchpoint. Each row contains the touchpoint’s partial credit (e.g., a $100 conversion with 4 touchpoints returns 4 rows with $25 each). Single-touch models (first_touch, last_touch) return one row per event.
• When sources are not provided, all events in the specified date are exported without attribution filtering
• The ad hierarchy fields (ad_id, ad_name, adset_id, adset_name, campaign_id, campaign_name, account_id, account_name) require sources to be provided. Requesting higher-level hierarchy fields (such as account_name) may increase processing time compared to requesting only lower-level fields (such as ad_name), so selecting only the fields you need will generally be more efficient.
• By default, only id and event_time_utc are included in the export (plus touchpoint_id when using attribution). Specify additional fields as needed to minimize file size.
• File Expiration: Download URLs expire after 15 minutes for security. Retrieve the file promptly after completion.
• Security: Export files use UUID-based filenames with time-limited presigned URLs to prevent unauthorized access