Skip to content
Store data and insights

Get ad spend usage

The workspace's Google Ads spend per property and day between start_date and end_date (YYYY-MM-DD), as billing counts it, with totals.

GET /companies/{companyId}/usage/ad-spend

Scope read · Access Read only · Operation id usage.get_ad_spend

Try it

productmetrics runs after productmetrics login; curl needs PM_TOKEN (see Authentication). Set $COMPANY_ID first.

productmetrics usage get-ad-spend \
  --company-id $COMPANY_ID \
  --start-date 2026-11-02 \
  --end-date 2026-11-02 \
  --json

Response

API response (200), shortened:

{
  "data": {
    "dataPoints": [
      {
        "date": "2026-11-02",
        "propertyId": "8c1f4d2e-7a3b-4c5d-9e6f-0a1b2c3d4e5f"
        // … 5 more fields
      }
    ],
    "properties": [
      {
        "propertyId": "8c1f4d2e-7a3b-4c5d-9e6f-0a1b2c3d4e5f",
        "propertyName": "Example Store"
        // … 2 more fields
      }
    ]
    // … 1 more field
  },
  "request_id": "req_01JSP2MHFDWBC0RZZ7XHD4QVVP"
}

CLI output: productmetrics usage get-ad-spend --json prints { "ok": true, "data": …, "request_id": "…" } with the same data.

Before you call

Any member of the workspace may read it.

Path parameters

NameTypeDescription
companyIdstring (uuid)Your workspace id, from productmetrics whoami or properties.list (company_id).

Query parameters

NameTypeRequiredDescription
start_datestring (date)YesFirst day of the range (YYYY-MM-DD).
end_datestring (date)YesLast day of the range (YYYY-MM-DD).

Errors

A failure answers with its HTTP status and { error: { code, message, details? }, request_id }. Branch on code (stable, lower_snake); show message to the person. The CLI prints the same error with "ok": false.

{
  "error": {
    "code": "insufficient_scope",
    "message": "This operation needs the read scope; connect again and allow it.",
    "details": {
      "required_scope": "read"
    }
  },
  "request_id": "req_01J02YW6J0MZW08D5T1C7RC0ZT"
}
StatusCodeWhen
400invalid_requestA path, query or body value does not match this page. details.issues lists each location, path and message.
401invalid_tokenThe token is missing, expired or revoked: sign in again (productmetrics login). The WWW-Authenticate header says why.
403insufficient_scopeThe token lacks the read scope (details.required_scope): sign in again and allow it.
404not_foundAn id in the path does not exist, or the signed-in person cannot open it.
429rate_limitedMore than 600 requests a minute for this person: wait the Retry-After seconds (60) and retry.

All Store data and insights operations