albertsons · JSON Structure

Retail Media Api Report Request Structure

Request body for generating a custom performance report.

Type: object Properties: 6 Required: 2
GroceryRetailRetail MediaAdvertisingCampaignsAnalyticsConsumer GoodsFoodPharmacy

Report Request is a JSON Structure definition published by albertsons, describing 6 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

campaignIds startDate endDate dimensions metrics format

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/albertsons/refs/heads/main/json-structure/retail-media-api-report-request-structure.json",
  "name": "Report Request",
  "description": "Request body for generating a custom performance report.",
  "type": "object",
  "properties": {
    "campaignIds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "List of campaign IDs to include in the report. Empty returns all.",
      "example": [
        "500123"
      ]
    },
    "startDate": {
      "type": "date",
      "description": "Start date for the report period (ISO 8601).",
      "example": "2026-03-01"
    },
    "endDate": {
      "type": "date",
      "description": "End date for the report period (ISO 8601).",
      "example": "2026-03-31"
    },
    "dimensions": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Dimensions to group report data by.",
      "example": [
        "date",
        "campaign"
      ]
    },
    "metrics": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Metrics to include in the report.",
      "example": [
        "impressions",
        "clicks",
        "roas"
      ]
    },
    "format": {
      "type": "string",
      "enum": [
        "json",
        "csv"
      ],
      "description": "Output format for the report.",
      "example": "json"
    }
  },
  "required": [
    "startDate",
    "endDate"
  ]
}