How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Scope3 Reporting API

Access performance metrics

Scope3 Reporting API is one of 51 APIs that Scope3 publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Reporting. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 3 operations across 3 paths, and defines 31 schemas. It is described by OpenAPI 3.2.0, at version 2.0.0.

Requests are made against 2 base URLs: https://api.interchange.io/api/v2/buyer, https://api.interchange.io/api/v2/storefront.

3 operations 3 paths 31 schemas 3 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0.0
Base URL
https://aiapi.scope3.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Scope3 Reporting API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth).

  • bearerAuth — API key or access token

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 3 GET. Each is listed below with its method, path, parameters, and response codes.

Reporting 3

Access performance metrics

GET
/advertisers/{advertiserId}/events/summary
Get event summary
getEventSummary 4 params → 200400401500
GET
/reporting/metrics
Get reporting
getReportingMetrics 9 params → 200400401500
GET
/reporting/margin
Get storefront margin (P&L) reporting
getStorefrontMarginReporting 2 params → 200400401500

Schemas 31

The contract defines 31 schemas that model the data the API accepts and returns. The most detailed are ReportingTotalsMetrics (15 properties), ReportingMetrics (15 properties), TimeseriesEntry (14 properties), StorefrontTimeseriesEntry (12 properties). Each schema is shown below with its type and property counts.

MediaBuyReporting
object
Media buy-level reporting metrics with package breakdown
7 properties 6 required
EventSummaryResponse
object
Response containing hourly-aggregated event counts for an advertiser
4 properties 4 required
EventSummaryEntry
object
A single hourly aggregation entry
3 properties 3 required
TimeseriesEntry
object
One row of metrics for a single (advertiser → campaign → media buy → package) leaf on a single day
14 properties 14 required
CampaignReporting
object
Campaign-level reporting metrics with media buy breakdown
5 properties 5 required
ReportingConversionInfo
object
How the consolidated (FX-converted) figures were produced
7 properties 7 required
AdvertiserReporting
object
Advertiser-level reporting metrics with campaign breakdown
5 properties 5 required
ConsolidatedReporting
object
FX-converted cross-advertiser rollup (display estimate only — never billing)
3 properties 3 required
ErrorResponse
object
Standard error response
2 properties 2 required
ReportingMetricsExportResponse
object
Response containing a signed URL to download the exported CSV
4 properties 4 required
ApiError
object
Structured error object
4 properties 2 required
PackageReporting
object
Package-level reporting metrics
4 properties 4 required
EventSummaryType
string
Type of event to filter by: conversion, click, impression, measurement, or mmp
ReportingTotalsMetrics
object
Reporting totals; money metrics are null when returned denominations mix or no denomination is available
15 properties 15 required
ReportingMetrics
object
Raw and calculated reporting metrics
15 properties 15 required
ReportingMetricsResponse
object
Hierarchical reporting response: advertiser → campaign → media buy → package
6 properties 5 required
CampaignManagement
string
Whether the platform acts on this campaign. "tracked" = a campaign the platform did not set up, mirrored from a connected seller account: the shell is derived…
ReportingMetricsTimeseriesResponse
object
Time-series reporting response: flat leaf × day rows (same hierarchy fields as the summary view, plus date)
5 properties 5 required
StorefrontReportingMetricsTimeseriesResponse
object
Time-series storefront reporting response: flat leaf × day rows
4 properties 4 required
SettlementStatus
string
Per-edge settlement state: booked (committed, no delivery yet), accruing (delivering), settled (final), void (cancelled — excluded from this report).
StorefrontAdvertiserReporting
object
Advertiser-level reporting metrics with media buy breakdown (no campaign level)
4 properties 4 required
MarginBuyer
object
Buyer-level P&L with media-buy breakdown
4 properties 4 required
MarginAmounts
object
Booked vs realized buy/sell/spread and margin %, one currency. The buy/sell/spread figures are independent coverage sums (each over the legs that carry that fi…
11 properties 11 required
StorefrontPackageReporting
object
Package-level reporting metrics
4 properties 4 required
StorefrontReportingMetricsResponse
object
Hierarchical storefront reporting response: advertiser → media buy → package
4 properties 4 required
StorefrontTimeseriesEntry
object
One row of metrics for a single (advertiser → media buy → package) leaf on a single day
12 properties 12 required
MarginMediaBuy
object
Media-buy-level P&L with package breakdown
3 properties 3 required
StorefrontMediaBuyReporting
object
Media buy-level reporting metrics with package breakdown
7 properties 7 required
StorefrontMarginReportingResponse
object
Hierarchical storefront margin (P&L) response: buyer → media buy → package → source leg
4 properties 4 required
MarginSourceLeg
object
One buy-leg edge: a single source package under a buyer package
5 properties 5 required
MarginPackage
object
Package-level P&L with per-source-leg breakdown. Package amounts are the sum of the source legs; this reconciles only while each buyer package routes to a sing…
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

scope3-reporting-api-openapi.yml Raw ↑

Other APIs Scope3 publishes across the network.

Scope3 AI Impact Measurement API
Scope3 Benchmarks API
Scope3 Creative API
Scope3 Data API
Scope3 Gpu API
Scope3 Impact API
Scope3 Measure API
Scope3 Model API
Scope3 Node API
Scope3 Reload API
Scope3 Saved Lists API
Scope3 Segment API
Where this information came from

This is an independent, third-party profile of Scope3 Reporting API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.