API Reference

Retrieve report 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/Advertisers/<AccountSID>/Reports/att_adv_performance_by_ad_cam_group/MetaData' \
  -X GET \
  -u '<AccountSID>:<AuthToken>' \
  -H 'Accept: application/json'

Example Response

{
  "Name": "Performance by Ad Campaign Group",
  "Id": "att_adv_performance_by_ad_cam_group",
  "Description": "Performance data aggregated by ad campaign and ad campaign group.",
  "Filters": [
    {
      "Name": "DEFAULT_MODEL",
      "DataType": "String",
      "Format": ""
      },
    {
      "Name": "Channel",
      "DataType": "String",
      "Format": ""
      },
    ...
  ],
  "Attributes": [
    {
      "Name": "Channel",
      "DataType": "String",
      "Description": ""
      },
    {
      "Name": "Media",
      "DataType": "String",
      "Description": ""
      },
    ...
    ],
  "RunUri": "/Advertisers/<AccountSID>/Reports/att_adv_performance_by_ad_cam_group",
  "Uri": "/Advertisers/<AccountSID>/Reports/att_adv_performance_by_ad_cam_group/MetaData"
}