Reports (Legacy)

Legacy synchronous reports endpoint. Subject to pagination limits — prefer ReportExport for large datasets.

List all reports

get

Returns the full catalog of reports available to your agency. Each report record indicates whether it is runnable via the API and exposes the URIs to run it synchronously (ApiRunUri), export it asynchronously (DeferredApiRunUri), or fetch its metadata (MetaDataUri).

Path parameters

AccountSIDstringRequired

Your Agency Account SID.

Example: IRq8mWJybvoQ1020978kbj7am8zzM2dBL1

Responses

200

A list of report definitions.

application/json

A single report definition in the report catalog.

NamestringOptional

The human-readable name of the report.

Example: Action Listing

IdstringOptional

The unique identifier of the report on impact.com. Use this as the ReportId path parameter when running or exporting the report. May not be present for some web-only reports.

Example: agency_action_listing

Categorystring · enumOptional

The category the report belongs to. Categories group reports by purpose in the impact.com UI.

Additional categories may exist beyond the values listed below.

Example: PerformancePossible values:

DescriptionstringOptional

A short explanation of the data this report shows.

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

ApiAccessiblebooleanOptional

Whether this report can be run via the API. When false, only RunUri (web app URL) is populated; the report can only be run from the impact.com UI.

Example: true

ApiRunUristring · uri-referenceOptional

The relative URI to run the report synchronously via the legacy GET /Reports/{ReportId} endpoint. Present when ApiAccessible is true.

Example: /Agencies/IRq8mWJybvoQ1020978kbj7am8zzM2dBL1/Reports/agency_action_listing

DeferredApiRunUristring · uri-referenceOptional

The relative URI to export the report asynchronously via the GET /ReportExport/{ReportId} endpoint. Present when ApiAccessible is true.

Recommended over ApiRunUri for any non-trivial report.

Example: /Agencies/IRq8mWJybvoQ1020978kbj7am8zzM2dBL1/ReportExport/agency_action_listing

MetaDataUristring · uri-referenceOptional

The relative URI to retrieve the report's metadata (filters and attributes). Present when ApiAccessible is true.

Example: /Agencies/IRq8mWJybvoQ1020978kbj7am8zzM2dBL1/Reports/agency_action_listing/MetaData

RunUristring · uri-referenceOptional

The relative URI to run the report in the impact.com web app. Present when ApiAccessible is false — these reports cannot be run via API.

Example: /secure/agency/report/viewReport.report?id=8019

401

Unauthorized. Check that your Account SID and Auth Token are correct.

get/Agencies/{AccountSID}/Reports

curl

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

[
  {
    "Name": "Action Listing",
    "Id": "agency_action_listing",
    "Category": "Performance",
    "Description": "Displays data for each individual action that has been credited to your media.",
    "ApiAccessible": true,
    "ApiRunUri": "/Agencies/IRq8mWJybvoQ1020978kbj7am8zzM2dBL1/Reports/agency_action_listing",
    "DeferredApiRunUri": "/Agencies/IRq8mWJybvoQ1020978kbj7am8zzM2dBL1/ReportExport/agency_action_listing",
    "MetaDataUri": "/Agencies/IRq8mWJybvoQ1020978kbj7am8zzM2dBL1/Reports/agency_action_listing/MetaData"
  }
]

Run a report

get

Runs a report and returns the records synchronously.

Legacy endpoint. This endpoint has pagination limits and may be rate-limited or capped on result size. For large datasets, use GET /ReportExport/{ReportId} instead, which schedules an asynchronous job and produces a downloadable result file.

Page size is fixed

As of October 2023, /Reports enforces a fixed PageSize of 20,000 records per response. Any PageSize value you pass is silently overridden. For larger datasets, use ReportExport.

Record values are returned as JSON strings

All record field values are returned as JSON strings, even when the report's metadata declares them as Decimal, Integer, Boolean, or Date. For example, a Decimal field returns "5.000000000000000000" (string), not 5.0 (number). Cast on the client side as needed — use MetaData.Attributes[].DataType to know the intended type.

Filter parameters

Filter parameters vary per report — call GET /Reports/{ReportId}/MetaData to discover which are supported. Convert each filter Name to uppercase with underscores ("Start Date" → START_DATE) when passing as a query parameter.

Path parameters

AccountSIDstringRequired

Your Agency Account SID.

Example: IRq8mWJybvoQ1020978kbj7am8zzM2dBL1

ReportIdstringRequired

The unique ID of the report to run.

Example: agency_action_listing

Query parameters

START_DATEstring · dateOptional

The start date (inclusive) for the report data, in YYYY-MM-DD format. Required by most reports.

Example: 2026-05-01

END_DATEstring · dateOptional

The end date (inclusive) for the report data, in YYYY-MM-DD format. Required by most reports.

Example: 2026-05-29

SUBAIDstringOptional

A program (campaign) ID to refine the report.

RQueryIDxintegerOptional

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

Default: 0

Responses

200

Success — a list of report record objects. Each record's field set depends on the report — refer to MetaData.Attributes for column descriptions.

Error — invalid input is returned as HTTP 200 with an error envelope ({"Status":"ERROR","Message":"..."}). Always check the Status field.

application/json

A single report record. Field names match the report's MetaData.Attributes.

Other propertiesanyOptional

401

Unauthorized. Check that your Account SID and Auth Token are correct.

get/Agencies/{AccountSID}/Reports/{ReportId}

curl

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

[
  {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
]

Get report metadata

get

Returns the metadata for a single report — its filters (input parameters) and attributes (output columns). Use this to discover which query parameters a report accepts before running or exporting it.

Path parameters

AccountSIDstringRequired

Your Agency Account SID.

Example: IRq8mWJybvoQ1020978kbj7am8zzM2dBL1

ReportIdstringRequired

The unique ID of the report whose metadata to retrieve.

Example: agency_action_listing

Responses

200

The metadata object for the requested report.

application/json

Metadata describing a single report's accepted filters (input parameters) and returned attributes (output columns).

NamestringOptional

The human-readable name of the report.

Example: Action Listing

IdstringOptional

The unique identifier of the report on impact.com.

Example: agency_action_listing

DescriptionstringOptional

A short explanation of the data this report shows.

RunUristring · uri-referenceOptional

The relative URI to run the report.

Uristring · uri-referenceOptional

The relative URI of this metadata resource.

401

Unauthorized. Check that your Account SID and Auth Token are correct.

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

curl

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

{
  "Name": "Action Listing",
  "Id": "agency_action_listing",
  "Description": "text",
  "Filters": [
    {
      "Name": "Start Date",
      "DataType": "String",
      "Format": ""
    }
  ],
  "Attributes": [
    {
      "Name": "ActionId",
      "DataType": "String",
      "Description": ""
    }
  ],
  "RunUri": "../folder",
  "Uri": "../folder"
}