API Reference

Retrieve metadata

Retrieves the dynamic documentation (aka the metadata) for a report. A report's metadata can tell you more about the information you retrieve when you run a report via API.

Parameters

No parameters.

Returns

Returns a report metadata object for the requested report. This request should never return an error.

Example request

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

Example response

{
  "Name": "Performance by Campaign",
  "Id": "agency_performance_by_campaign",
  "Description": "Displays performance data aggregated by campaign.",
  "Filters": [
    {
      "Name": "Media Type",
      "DataType": "String",
      "Format": ""
    },
    {
      ...
    }
  ],
  "Attributes": [
    {
      "Name": "Campaign",
      "DataType": "String",
      "Description": ""
    },
    {
      ...
    }
  ],
  "RunUri": "/Agencies/<AccountSID>/Reports/agency_performance_by_campaign",
  "Uri": "/Agencies/<AccountSID>/Reports/agency_performance_by_campaign/MetaData"
}