API Keys and REST Access: Getting EndFrame Data Into Your External Tools

When your BI tool, internal dashboard, or automation workflow needs attribution data, a REST API with proper key management is the answer. Here is how EndFrame handles API access securely.

The EndFrame Team6 min read

Dashboards are built for people. APIs are built for systems. As teams grow, the need to get attribution data out of the dashboard and into external tools becomes unavoidable. A BI team wants to join campaign data with revenue numbers. An ops team wants to pipe visit data into a monitoring system. An AI agent needs to query engagement metrics. All of these require programmatic access, and that starts with a well-managed API.

Why API key management matters

An API without proper key management is a security risk and an operational headache. You need to know which system is accessing what, be able to cut access instantly if a key leaks, and give different integrations their own credentials so revoking one does not break everything else. These are not edge cases. They are the baseline for any team running integrations in production.

How EndFrame handles API keys

EndFrame's API key management is built into the dashboard settings panel. The workflow is straightforward:

  1. 1Create a new key and give it a descriptive name that identifies the integration.
  2. 2Copy the key at creation time — it is shown once for security.
  3. 3Enable or disable a key without deleting it, useful for temporary pauses.
  4. 4Revoke a key permanently when an integration is retired or a key is compromised.

Keys are workspace-scoped, which means they inherit the same data isolation that protects everything else in your workspace. A key from one workspace cannot access another workspace's data.

What the REST API exposes

The REST API is designed around the data teams most commonly need to pull into external systems:

  • Campaigns: list, search, and retrieve campaign details including status, domain, and mapped parameters.
  • Visits: pull session data with source parameters, engagement time, scroll depth, and device context.
  • Analytics: query breakdowns by source, language, screen resolution, and time period.
  • Engagement KPIs: retrieve average engagement time and scroll depth across campaigns or workspace-wide.

Common integration patterns

Most teams start with one of a few common patterns. BI integrations pull campaign and visit data on a schedule and join it with revenue data in a warehouse. Monitoring setups query engagement KPIs and alert when metrics drop below thresholds. Automation workflows trigger actions when new campaigns are created or when visit volume spikes. The REST API is generic enough to support all of these without custom middleware.

An attribution platform that traps your data behind a login screen is a reporting tool. One that lets your data flow where it needs to go is infrastructure.

Getting started with API access

Enable the REST API add-on from the EndFrame marketplace, create a named API key from the settings panel, and start making requests. The API follows standard REST conventions with JSON responses, so any HTTP client or integration platform can connect. Combined with the MCP server for AI agents and the tracking pixel for lightweight collection, the REST API completes the picture: data flows into EndFrame through tracking, and out through APIs, so your attribution workspace works with your stack instead of next to it.

Frequently asked questions

How do I create an API key in EndFrame?

API keys are managed from the settings panel in the dashboard. You can create a new key, give it a descriptive name, and it is ready to use immediately. Keys can be enabled, disabled, or revoked at any time.

What can I do with the REST API?

The REST API lets you list campaigns, retrieve visit data with session and engagement details, pull analytics breakdowns by source, language, or device, and export metrics. It covers the same data visible in the dashboard, accessible programmatically.

Is API access secure?

Yes. Every API request requires a valid key. Keys are workspace-scoped, so they only access data within your workspace. You can disable or revoke a key instantly if it is compromised, and the audit trail shows which key made which request.

Try EndFrame

Bring reporting, campaigns, and clean source data into one workspace.

EndFrame keeps attribution, campaign operations, and governance connected so your team can move quickly without losing trust in the numbers.

No credit card required

Keep reading