Reports

List All Available Reports

get

Retrieves a list of all reports available to your account, indicating whether they can be run via the API.

Authorizations

AuthorizationstringRequired

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

Path parameters

AccountSIDstringRequired

Your unique Account SID.

Responses

200

A paginated list of report metadata objects.

application/json

get/Advertisers/{AccountSID}/Reports

cURL

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

200

A paginated list of report metadata objects.

{
  "Reports": [
    {
      "Name": "Action Listing",
      "Id": "adv_action_listing_pm",
      "Category": "Performance",
      "Description": "Lists all actions for a date range.",
      "ApiAccessible": true,
      "ApiRunUri": "/Advertisers/<AccountSID>/Reports/adv_action_listing_pm",
      "DeferredApiRunUri": "/Advertisers/<AccountSID>/ReportExport/adv_action_listing_pm",
      "MetaDataUri": "/Advertisers/<AccountSID>/ReportsMetadata/adv_action_listing_pm",
      "RunUri": "https://app.impact.com/secure/reports/run/adv_action_listing_pm"
    }
  ]
}

Run a Report Synchronously

get

Runs a report and returns the data directly in the response. The required filter parameters (like SUBAID, StartDate, EndDate) depend on the specific report being run. Retrieve the report's metadata to see all available filters.

Authorizations

AuthorizationstringRequired

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

Path parameters

AccountSIDstringRequired

ReportIdstringRequired

The unique identifier of the report to run.

Query parameters

SUBAIDintegerOptional

Required for most reports. The ID of the program (campaign) to filter by.

StartDatestring · dateOptional

Required for most reports. The start of the date range for the report data.

EndDatestring · dateOptional

Required for most reports. The end of the date range for the report data.

Responses

200

A paginated list of report records. The structure of each record depends on the report run.

application/json

Recordsobject[]Optional

The records from the report.

get/Advertisers/{AccountSID}/Reports/{ReportId}

cURL

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

200

A paginated list of report records. The structure of each record depends on the report run.

{
  "Records": [
    {}
  ]
}

Export a Report Asynchronously

get

Schedules a job to export a report as a file. Returns URIs to monitor the job's status and download the result.

Authorizations

AuthorizationstringRequired

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

Path parameters

AccountSIDstringRequired

ReportIdstringRequired

The unique identifier of the report to export.

Query parameters

PUB_CAMPAIGNintegerOptional

Required for most reports. The ID of the program (campaign).

StartDatestring · date-timeOptional

Required for most reports. The start of the date range, as an ISO 8601 date-time (YYYY-MM-DDThh:mm:ssZ), e.g. 2026-01-15T00:00:00Z.

EndDatestring · date-timeOptional

Required for most reports. The end of the date range, as an ISO 8601 date-time (YYYY-MM-DDThh:mm:ssZ), e.g. 2026-01-15T00:00:00Z.

ResultFormatstring · enumOptionalDefault: CSVPossible values:

Responses

200

The report export job was successfully queued.

application/json

StatusstringOptional

Indicates whether the job was queued successfully.

Example: QUEUED

QueuedUristring · uri-referenceOptional

The URI to poll for the job's status.

ResultUristring · uri-referenceOptional

The URI to download the result file once the job completes.

get/Advertisers/{AccountSID}/ReportExport/{ReportId}

cURL

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

200

The report export job was successfully queued.

{
  "Status": "QUEUED",
  "QueuedUri": "../folder",
  "ResultUri": "../folder"
}

Retrieve Report Metadata

get

Retrieves the dynamic documentation for a specific API-accessible report, including its available filters and attributes.

Authorizations

AuthorizationstringRequired

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

Path parameters

AccountSIDstringRequired

ReportIdstringRequired

Responses

200

A report metadata object.

application/json

Dynamic documentation for a specific report, detailing its filters and attributes.

NamestringOptional

The display name of the report.

Example: Action Listing

IdstringOptional

The unique identifier or handle for the report.

Example: adv_action_listing_pm

DescriptionstringOptional

A description of what the report contains.

Example: Lists all actions for a date range.

RunUristring · uri-referenceOptional

The URI to run this report.

Example: /Advertisers/<AccountSID>/Reports/adv_action_listing_pm

Uristring · uri-referenceOptional

The unique reference to this metadata object in the impact.com API.

Example: /Advertisers/<AccountSID>/ReportsMetadata/adv_action_listing_pm

get/Advertisers/{AccountSID}/Reports/{ReportId}/MetaData

cURL

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

200

A report metadata object.

{
  "Name": "Action Listing",
  "Id": "adv_action_listing_pm",
  "Description": "Lists all actions for a date range.",
  "Filters": [
    {
      "Name": "DEFAULT_MODEL",
      "DataType": "String",
      "Format": ""
    }
  ],
  "Attributes": [
    {
      "Name": "ActionDate",
      "DataType": "DATETIME",
      "Description": "Date the action occurred."
    }
  ],
  "RunUri": "/Advertisers/<AccountSID>/Reports/adv_action_listing_pm",
  "Uri": "/Advertisers/<AccountSID>/ReportsMetadata/adv_action_listing_pm"
}