Data & Tools

Data Exports

Generate API keys to access your marketing data programmatically.

Data ExportsComing Soon

Overview

Data Exports lets you generate API credentials to access your Adverfly data programmatically. Create API keys, manage access, and use the built-in documentation to query events, sessions, conversions, and ad performance data via the REST API.

Key Features

  • API Key Management: Generate, name, and revoke API credentials
  • Client Secret Security: Client secrets are shown only once at creation — download or copy immediately
  • Built-In API Docs: View available endpoints, parameters, and example requests directly in the app
  • Multiple Keys: Create multiple API keys for different use cases or team members

Available API Endpoints

All endpoints use the base URL https://api.adverfly.com with header authentication:

EndpointDescription
GET /v3/eventsPageviews, clicks, and custom events
GET /v3/sessionsUser sessions with entry/exit pages
GET /v3/conversionsPurchase and conversion events
GET /v3/adsAd performance data (spend, impressions, clicks, reach)

Authentication

Every request requires two headers:

  • x-api-key — Your API key
  • client-secret — Your client secret

Common Parameters

ParameterDescription
start_dateStart of date range (YYYY-MM-DD)
end_dateEnd of date range (YYYY-MM-DD)
nameFilter by event name
sourceComma-separated ad sources (e.g. meta,google). Ads endpoint.
limitNumber of results per page (max 500)
offsetPagination offset

How It Works

When you create an API key, Adverfly generates a key pair (API key + client secret). The key inherits your workspace permissions, allowing programmatic access to the same data you see in the dashboard. Use the credentials in your scripts, data pipelines, or BI tools to query Adverfly data.

Use Cases

  • Data Pipelines: Pull data into your data warehouse or BI tools
  • Custom Dashboards: Build custom visualizations with your own tools
  • Automated Reporting: Schedule scripts to pull and format data automatically
  • Third-Party Integrations: Connect Adverfly data to tools not natively supported

Getting Started

  1. Open Data Exports from the sidebar
  2. Click Create API Key
  3. Name your key and confirm
  4. Copy or download the client secret immediately (it will not be shown again)
  5. Use the API key and client secret in your HTTP requests