API Reference

List all reports

Retrieves a list of all available reports.

The example response only represents two possible reports.

Parameters

No parameters.

Returns

Returns an array of report objects up to a limit dictated by @pagesize. Each entry in the array is a separate report object. If no report objects meet the criteria, the resulting array will be empty. This request should never return an error.

Example request

curl 'https://api.impact.com/Agencies/<AccountSID>/Reports' \
  -G \
  -u '<AccountSID>:<AuthToken>' \
  -H 'Accept: application/json' \

Example response

{
  "@page": "1",
  "Reports": [
    {
      "Name": "Performance by Campaign",
      "Id": "agency_performance_by_campaign",
      "Category": "Performance",
      "Description": "Displays aggregate performance by campaign.",
      "ApiAccessible": true,
      "ApiRunUri": "/Agencies/<AccountSID>/Reports/agency_performance_by_campaign",
      "MetaDataUri": "/Agencies/<AccountSID>/Reports/agency_performance_by_campaign/MetaData"
    },
    {
      "Name": "Performance by Media",
      "Id": "agency_performance_by_media",
      "Category": "Performance",
      "Description": "Displays aggregate performance by media.",
      "ApiAccessible": true,
      "ApiRunUri": "/Agencies/<AccountSID>/Reports/agency_performance_by_media",
      "MetaDataUri": "/Agencies/<AccountSID>/Reports/agency_performance_by_media/MetaData"
      },
    ...
  ]
}