Contents

BrandsSearchTermReportResponse

The top-level response envelope for brands search term reports.

Declaration

object BrandsSearchTermReportResponse

Properties

NameTypeDescription
resultBrandsSearchTermResultContainer

If no rows match the request, result is returned as an empty object. See BrandsSearchTermResultContainer for details.

paginationResponsePagination

See ResponsePagination for details.

errorError

See ErrorResponse for details.

Discussion

The result field contains a BrandsSearchTermResultContainer with the array of search term rows, each capturing the actual user query text and associated brands performance metrics.

Like all search term reports, brands search term reports require the ORTZ timezone. UTC isn’t supported. Search term entity reports also exclude the supplyPlacement and locationId dimensions from groupBy. The pagination field provides the pagination state.

Example

{
  "result": {
    "rows": [
      {
        "totalMetrics": {
          "date": "2025-01-10",
          "localSpend": {
            "amount": "245.50",
            "currency": "USD"
          },
          "impressions": 18400,
          "taps": 620
        },
        "metadata": {
          "searchTermText": "awayfinder travel app",
          "locationId": "555666777"
        }
      }
    ],
    "summary": {
      "grandTotal": {
        "localSpend": {
          "amount": "245.50",
          "currency": "USD"
        },
        "impressions": 18400,
        "taps": 620
      }
    }
  },
  "pagination": {
    "offset": 0,
    "pageSize": 20,
    "totalCount": 1
  }
}

See Also