Contents

BrandsKeywordReportResponse

The top-level response envelope for brands keyword-level reports.

Declaration

object BrandsKeywordReportResponse

Properties

NameTypeDescription
resultBrandsKeywordResultContainer

Wraps the report rows, each containing keyword metadata and associated brands performance metrics. If no rows match the request, result is returned as an empty object. See BrandsKeywordResultContainer for details.

paginationResponsePagination

See ResponsePagination for details.

errorError

See ErrorResponse for details.

Discussion

The brands keyword reports exclude both supplyPlacement and locationId from supported groupBy dimensions. Use deviceClass only.

Example

{
  "result": {
    "rows": [
      {
        "metadata": {
          "locationId": "555666777",
          "matchType": "PHRASE"
        },
        "totalMetrics": {
          "date": "2025-01-10",
          "localSpend": {
            "amount": "845.50",
            "currency": "USD"
          },
          "impressions": 620000,
          "taps": 9800,
          "ttr": 0.0158,
          "cpt": {
            "amount": "0.09",
            "currency": "USD"
          },
          "cpm": {
            "amount": "1.36",
            "currency": "USD"
          }
        },
        "granularMetrics": [
          {
            "date": "2025-01-10",
            "localSpend": {
              "amount": "845.50",
              "currency": "USD"
            },
            "impressions": 620000,
            "taps": 9800,
            "ttr": 0.0158,
            "cpt": {
              "amount": "0.09",
              "currency": "USD"
            },
            "cpm": {
              "amount": "1.36",
              "currency": "USD"
            }
          }
        ],
        "insights": {
          "bidRecommendation": {
            "suggestedBidAmount": 2.35
          }
        }
      }
    ],
    "summary": {
      "grandTotal": {
        "date": "2025-01-10",
        "localSpend": {
          "amount": "845.50",
          "currency": "USD"
        },
        "impressions": 620000,
        "taps": 9800,
        "ttr": 0.0158,
        "cpt": {
          "amount": "0.09",
          "currency": "USD"
        },
        "cpm": {
          "amount": "1.36",
          "currency": "USD"
        }
      }
    }
  },
  "pagination": {
    "offset": 0,
    "pageSize": 20,
    "totalCount": 1
  }
}

See Also