Skip to main content

Get performance statistics (campaign)

GET 
/v1/partnership/reports/conversion/campaign/:campaign_code

Return acquisition and conversion performance for one campaign. Use the campaign code from the Campaigns API and optional date, country, tag, and referrer filters to narrow the result.

Required scopes:

  • read: partnership.all:read or partnership.all.

Runtime restrictions:

  • Metrics are evaluated in the partner context associated with the API key and restricted to the campaign_code in the path. If no matching conversion events exist, the report returns an empty result set.

Rules:

  • The campaign is selected only by the required campaign_code path parameter.
  • You can provide at most four tags. Each tag must contain one to 16 letters, digits, or underscores.
  • campaign_title, when supplied, can contain up to 100 characters.

Rate limits:

  • This operation counts toward the shared limit of 600 requests per 60 seconds per partner, across all of the partner's API keys and all Partnership API operations.

Consistency and recovery notes:

  • This read operation can be retried. Results may change as report data is updated. Keep the same filters and ordering when reading additional pages, where pagination is supported.

Possible errors:

  • Throttled
  • ServiceTransportError
  • Error
  • AuthenticationFailed
  • PermissionDenied
  • ValidationError
  • NotFound

Request​

Responses​

Successful response.