Reports

List available reports, fetch their metadata, and run them synchronously.

List all reports

get

Retrieves a list of all available reports. Only reports with ApiAccessible: true can be run programmatically — the rest are UI-only and return a RunUri pointing to the impact.com web app.

Authorizations

AuthorizationstringRequired

Use your AccountSID as the username and AuthToken as the password.

Path parameters

AccountSIDstringRequired

Unique identifier for the partner account.

Responses

200

OK

application/json

get/Mediapartners/{AccountSID}/Reports

curl

curl -L \
  --url 'https://api.impact.com/Mediapartners/{AccountSID}/Reports' \
  --user '{AccountSID}:{AuthToken}' \
  --header 'Accept: */*'

200

OK

{
  "Reports": [
    {
      "Name": "Action Listing",
      "Id": "mp_action_listing_fast",
      "Category": "Listing",
      "Description": "Displays data for each individual action that has been credited to you.",
      "ApiAccessible": true,
      "ApiRunUri": "/Mediapartners/<AccountSID>/Reports/mp_action_listing_fast",
      "DeferredApiRunUri": "/Mediapartners/<AccountSID>/ReportExport/mp_action_listing_fast",
      "MetaDataUri": "/Mediapartners/<AccountSID>/Reports/mp_action_listing_fast/MetaData",
      "RunUri": "/secure/mediapartner/report/viewReport.report?id=17698"
    }
  ]
}

Run a report (Legacy)

get

Runs a report synchronously and returns the records inline. Page size is fixed at 20,000 rows — for larger datasets use the Report Export endpoint instead.

Call /Reports/{Id}/MetaData first to learn which filters the report accepts and which columns it returns. The Records array contains one object per row with column names matching the metadata Attributes.

Overload handling: When the reporting service is under heavy load this endpoint returns 503 with a Retry-After header. Wait the indicated number of seconds before retrying. Use the Report Export endpoint for large datasets to avoid this altogether.

Authorizations

AuthorizationstringRequired

Use your AccountSID as the username and AuthToken as the password.

Path parameters

AccountSIDstringRequired

Unique identifier for the partner account.

IdstringRequired

The report handle (e.g., mp_action_listing_fast). Get this from the Id field returned by List Reports.

Query parameters

SUBAIDstringOptional

Program ID to scope the report to a single brand. Omit to include all programs you partner with.

Example: 10306

START_DATEstring · dateRequired

Start date for the report's date range, in YYYY-MM-DD format.

Example: 2026-01-01

END_DATEstring · dateRequired

End date for the report's date range, in YYYY-MM-DD format.

Example: 2026-01-31

RQueryIDxintegerOptional

For reports that return multiple result tables, selects which table to return.

Default: 0

Responses

200

OK

application/json

404

No report exists with the supplied Id, or the report is not API accessible.

408

The report query exceeded the server-side timeout. Retry later or use the Report Export endpoint for large datasets which run asynchronously without a timeout.

application/json

503

The reporting service is temporarily busy. Wait the number of seconds specified in the Retry-After response header before retrying. Use the Report Export endpoint for large datasets to avoid this condition entirely.

application/json

get/Mediapartners/{AccountSID}/Reports/{Id}

curl

curl -L \
  --url 'https://api.impact.com/Mediapartners/{AccountSID}/Reports/{Id}' \
  --user '{AccountSID}:{AuthToken}' \
  --header 'Accept: */*'

{
  "Records": [
    {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ]
}

Retrieve report metadata

get

Returns the dynamic documentation for a report — the filters it accepts and the attributes (columns) it returns. Call this before running a report to learn its exact contract.

Authorizations

AuthorizationstringRequired

Use your AccountSID as the username and AuthToken as the password.

Path parameters

AccountSIDstringRequired

Unique identifier for the partner account.

IdstringRequired

The report handle (e.g., mp_action_listing_fast). Get this from the Id field returned by List Reports.

Responses

200

OK

application/json

NamestringOptional

Display name of the report.

Example: Action Listing

IdstringOptional

The report handle.

Example: mp_action_listing_fast

DescriptionstringOptional

A short description of what the report contains.

Example: Displays data for each individual action that has been credited to you.

RunUristringOptional

API resource path to run this report.

Example: /Mediapartners/<AccountSID>/Reports/mp_action_listing_fast

UristringOptional

Unique reference to this report's metadata in the impact.com API.

Example: /Mediapartners/<AccountSID>/Reports/mp_action_listing_fast/MetaData

404

No report exists with the supplied Id.

get/Mediapartners/{AccountSID}/Reports/{Id}/MetaData

curl

curl -L \
  --url 'https://api.impact.com/Mediapartners/{AccountSID}/Reports/{Id}/MetaData' \
  --user '{AccountSID}:{AuthToken}' \
  --header 'Accept: */*'

{
  "Name": "Action Listing",
  "Id": "mp_action_listing_fast",
  "Description": "Displays data for each individual action that has been credited to you.",
  "Filters": [
    {
      "Name": "START_DATE",
      "DataType": "String",
      "Format": ""
    }
  ],
  "Attributes": [
    {
      "Name": "action_id",
      "DataType": "String",
      "Description": "Unique value assigned to each action"
    }
  ],
  "RunUri": "/Mediapartners/<AccountSID>/Reports/mp_action_listing_fast",
  "Uri": "/Mediapartners/<AccountSID>/Reports/mp_action_listing_fast/MetaData"
}