API

List reporting metadata

Returns tables, columns and help text available to the advertiser (same key and format query parameters as GET /apidata). The response shape depends on format: json returns a structured JSON object, while csv, excel, and human return tabular text/binary representations of the same metadata. There is no filter query parameter on this route; call /apidata to apply filter. Use /apilist first to discover column identifiers for data, sum, and filter.

get/apilist

Request

Query parameters

keystring required

Advertiser API key (required on every request).

format'human' | 'json' | 'csv' | 'excel'

defines the content type of the response

Response

Metadata payload in the requested format

Example response

{
  "tables": [
    {
      "name": "Inventory",
      "friendly": "Inventory Data",
      "help": "Contains inventory information",
      "columns": [
        {
          "name": "Day",
          "friendly": "Day",
          "help": "The date of the data",
          "format": "date",
          "icon": "calendar",
          "table": "Inventory",
          "fully_qualified_name": "Inventory.Day"
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.