Reports (Legacy)

List All Available Reports

get

Retrieves a list of all reports available to the account.

Authorizations

basicAuth

AuthorizationstringRequired

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

Path parameters

AccountSIDstringRequired

Responses

200

A paginated list of report 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 objects.

{
  "Reports": [
    {
      "Name": "DEFAULT_MODEL",
      "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 (Legacy)

get

Runs a report and returns the records synchronously. This is a legacy endpoint with pagination limits. Use the ReportExport endpoint for more efficient exporting.

Authorizations

basicAuth

AuthorizationstringRequired

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

Path parameters

AccountSIDstringRequired

ReportIdstringRequired

The unique ID or handle for the report.

Query parameters

SUBAIDintegerOptional

Program ID. Required for most reports.

StartDatestring · dateOptional

Start date in YYYY-MM-DD format. Required for most reports.

EndDatestring · dateOptional

End date in YYYY-MM-DD format. Required for most reports.

RQueryIDxintegerOptional

For reports with multiple tables, specifies which table to return (0-indexed).

Default: 0

Responses

200

A paginated list of report records.

application/json

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.

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

Retrieve Report Metadata

get

Retrieves the dynamically generated documentation (metadata) for a specific report, including available filters and attributes.

Authorizations

basicAuth

AuthorizationstringRequired

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

Path parameters

AccountSIDstringRequired

ReportIdstringRequired

The unique ID or handle of the report.

Responses

200

The metadata object for the requested report.

application/json

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

The metadata object for the requested report.

{
  "Name": "Action Listing",
  "Id": "adv_action_listing_pm",
  "Description": "Lists all actions for a date range.",
  "Filters": [
    {
      "Name": "START_DATE",
      "DataType": "DATE",
      "Format": "yyyy-MM-dd"
    }
  ],
  "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"
}