# Google Analytics Report (`google-analytics.report`)

Runs a Google Analytics 4 report for a property: any dimensions and metrics over date ranges, with filters, sorting and paging.

Docs: https://primaryapi.com/docs/api-reference/google-analytics/report

- Endpoint: `POST https://api.primaryapi.com/v1/run/google-analytics.report`
- Category: Web Intelligence · Platform: `google-analytics` · Kind: search · Status: live
- Price: 1 credit per call. Every call costs the same, including calls that were retried automatically.
- Billing unit: per successful call
- Reliability: routed to a healthy upstream and retried automatically when an attempt fails; live 30-day status: `GET https://api.primaryapi.com/v1/status/apis?sku=google-analytics.report`
- Execution: synchronous (answers 202 only if it outlives the wait window)

## Input

| Field | Type | Required | Default | Constraints | Description |
|---|---|---|---|---|---|
| `propertyId` | string | yes |  | pattern: ^(?:properties\/)?(\d{1,20})$ | GA4 property id, e.g. "123456789" (or "properties/123456789"), as google-analytics.properties lists it. |
| `dateRanges` | object[] | no | [{"startDate":"28daysAgo","endDate":"yesterday"}] | min 1 items; max 4 items | Date ranges (1-4). Default: the last 28 days up to yesterday. |
| `dateRanges[].startDate` | string | yes |  | pattern: ^(?:\d{4}-\d{2}-\d{2}\|\d{1,4}daysAgo\|yesterday\|today)$ | First day: YYYY-MM-DD, NdaysAgo, yesterday or today (property time zone). |
| `dateRanges[].endDate` | string | yes |  | pattern: ^(?:\d{4}-\d{2}-\d{2}\|\d{1,4}daysAgo\|yesterday\|today)$ | Last day, inclusive: YYYY-MM-DD, NdaysAgo, yesterday or today. |
| `dateRanges[].name` | string | no |  | max 100 chars | Optional name, returned in the dateRange dimension when several ranges are requested. |
| `dimensions` | string[] | no | [] | max 9 items; items max 200 chars; items pattern: ^[A-Za-z][A-Za-z0-9_:]*(?:\[[A-Za-z0-9_]+\])?$ | Dimensions to group by (API names, up to 9), e.g. ["date", "sessionDefaultChannelGroup"]. List them with google-analytics.metadata. |
| `metrics` | string[] | yes |  | min 1 items; max 10 items; items max 200 chars; items pattern: ^[A-Za-z][A-Za-z0-9_:]*(?:\[[A-Za-z0-9_]+\])?$ | Metrics to return (API names, 1-10), e.g. ["activeUsers", "sessions", "keyEvents"]. List them with google-analytics.metadata. |
| `dimensionFilter` | object | no |  |  | Optional GA4 FilterExpression on dimensions, e.g. {"filter":{"fieldName":"country","stringFilter":{"matchType":"EXACT","value":"France"}}}; combine with andGroup / orGroup / notExpression. |
| `metricFilter` | object | no |  |  | Optional GA4 FilterExpression on metrics, applied after aggregation, e.g. {"filter":{"fieldName":"sessions","numericFilter":{"operation":"GREATER_THAN","value":{"int64Value":"100"}}}}. |
| `orderBys` | object[] | no |  | max 10 items | Sort order, e.g. [{"metric":{"metricName":"sessions"},"desc":true}]. |
| `orderBys[].metric` | object | no |  |  |  |
| `orderBys[].dimension` | object | no |  |  |  |
| `orderBys[].desc` | boolean | no |  |  | Descending when true |
| `metricAggregations` | enum[] | no |  | max 4 items | Also return totals / minimums / maximums / counts of the metrics. |
| `currencyCode` | string | no |  | pattern: ^[A-Z]{3}$ | ISO 4217 currency for revenue metrics (default: the property’s currency). |
| `keepEmptyRows` | boolean | no | false |  | Keep rows whose metrics are all 0 (default false). |
| `limit` | integer | no | 100 | 1–10000 | Maximum number of results to return (1-10000, default 100). |
| `cursor` | string | no |  |  | Opaque pagination cursor: pass the previous response's nextCursor. |
| `connection` | string | no |  | max 200 chars | Which connected account to use when the workspace has several for this provider: the customId you gave it (exact), its connection id ("con_…"), its handle (login, email or @handle) or its name. Optional; prefer the customId or id, which never match two accounts. |

Unknown fields are rejected with `400 invalid_input`. The routing controls `preferLatencyUnderMs` and `maxCredits` may be sent in the same JSON body.

## Output

When `output.found` is `true`, `output.data` has this shape:

| Field | Type | Description |
|---|---|---|
| `rows` | object[] |  |
| `rows[].dimensions` | object | Dimension values by API name |
| `rows[].metrics` | object | Metric values by API name (numbers) |
| `dimensionHeaders` | string[] |  |
| `metricHeaders` | object[] |  |
| `metricHeaders[].name` | string |  |
| `metricHeaders[].type` | string \| null | TYPE_INTEGER, TYPE_CURRENCY, … |
| `totals` | object[] |  |
| `totals[].dimensions` | object | Dimension values by API name |
| `totals[].metrics` | object | Metric values by API name (numbers) |
| `maximums` | object[] |  |
| `maximums[].dimensions` | object | Dimension values by API name |
| `maximums[].metrics` | object | Metric values by API name (numbers) |
| `minimums` | object[] |  |
| `minimums[].dimensions` | object | Dimension values by API name |
| `minimums[].metrics` | object | Metric values by API name (numbers) |
| `rowCount` | integer \| null | Rows in the whole result, regardless of limit |
| `propertyQuota` | object \| null | The property’s Data API quota after this call (tokensPerDay, tokensPerHour, …) |
| `metadata` | object |  |
| `metadata.currencyCode` | string \| null |  |
| `metadata.timeZone` | string \| null |  |
| `metadata.subjectToThresholding` | boolean | Some rows were withheld by Google’s privacy thresholds |
| `metadata.dataLossFromOtherRow` | boolean | Some values were grouped into "(other)" |
| `metadata.sampled` | boolean | The report is based on a sample of events |
| `metadata.emptyReason` | string \| null |  |
| `nextCursor` | string \| null |  |

When the thing you asked about does not exist (or a search matches nothing) the call still succeeds: `output.found` is `false`, `output.data` is `null` and `output.reason` says why (`not_found`, `private`, `no_results`, …). Misses are free unless the notes below say misses are billed.

Pagination: pass the previous response’s `nextCursor` as `cursor` to get the next page; `nextCursor: null` means there are no more results.

## Example request

```bash
curl -sS -X POST "https://api.primaryapi.com/v1/run/google-analytics.report" \
  -H "Authorization: Bearer $PRIMARYAPI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"propertyId":"312345678","dimensions":["sessionDefaultChannelGroup"],"metrics":["sessions","engagementRate"],"orderBys":[{"metric":{"metricName":"sessions"},"desc":true}],"limit":2}'
```

## Example response

_Values are placeholders that follow the output schema; `credits` is what this call would cost at the usual price._

```json
{
  "output": {
    "found": true,
    "data": {
      "rows": [
        {
          "dimensions": {
            "sessionDefaultChannelGroup": "Organic Search"
          },
          "metrics": {
            "sessions": 5120,
            "engagementRate": 0.6312
          }
        },
        {
          "dimensions": {
            "sessionDefaultChannelGroup": "Direct"
          },
          "metrics": {
            "sessions": 2210,
            "engagementRate": 0.5544
          }
        }
      ],
      "dimensionHeaders": [
        "sessionDefaultChannelGroup"
      ],
      "metricHeaders": [
        {
          "name": "sessions",
          "type": "TYPE_INTEGER"
        },
        {
          "name": "engagementRate",
          "type": "TYPE_FLOAT"
        }
      ],
      "totals": [],
      "maximums": [],
      "minimums": [],
      "rowCount": 6,
      "propertyQuota": {
        "tokensPerDay": {
          "consumed": 12,
          "remaining": 199870
        },
        "tokensPerHour": {
          "consumed": 12,
          "remaining": 39950
        },
        "concurrentRequests": {
          "consumed": null,
          "remaining": 10
        },
        "serverErrorsPerProjectPerHour": {
          "consumed": null,
          "remaining": 10
        },
        "potentiallyThresholdedRequestsPerHour": {
          "consumed": null,
          "remaining": 120
        },
        "tokensPerProjectPerHour": {
          "consumed": 12,
          "remaining": 13970
        }
      },
      "metadata": {
        "currencyCode": "USD",
        "timeZone": "America/Los_Angeles",
        "subjectToThresholding": false,
        "dataLossFromOtherRow": false,
        "sampled": false,
        "emptyReason": null
      },
      "nextCursor": "eyJvIjoyfQ"
    }
  },
  "provider": "PrimaryAPI",
  "credits": 1,
  "items": 2,
  "requestId": "req_01JBXK6Y2N9V8T4R3Q2P1M0A7Z",
  "nextCursor": null
}
```

## Pricing and reliability

- Usual price: 1 credit per call
- Price ceiling: the usual price, even when a call is retried. A quote’s `maxCredits` is the most a given call can cost; the `maxCredits` routing control caps it per call
- Live 30-day status, success rate, uptime and latency: `GET https://api.primaryapi.com/v1/status/apis?sku=google-analytics.report`

## Errors to handle

`invalid_input`, `unauthorized`, `insufficient_balance`, `key_limit_reached`, `trial_cap_reached`, `forbidden`, `not_found`, `idempotency_conflict`, `rate_limited`, `all_sources_failed`, `service_unavailable`, `timeout`. See https://primaryapi.com/docs/errors.

## Notes

Runs as your connected Google account and needs the Read Google Analytics capability (analytics_read). Uses the GA4 Data API: dimension and metric API names come from google-analytics.metadata (custom ones look like "customEvent:plan_type"). Each call spends the property’s own Data API quota (shown in propertyQuota); when it runs out Google answers with a rate limit until the quota refills. With several date ranges each row also carries its date range (index or name).

