# Google Analytics Custom Dimensions (`google-analytics.custom_dimensions`)

Lists the custom dimensions of a Google Analytics 4 property with the parameter each one reads and its scope.

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

- Endpoint: `POST https://api.primaryapi.com/v1/run/google-analytics.custom_dimensions`
- Category: Web Intelligence · Platform: `google-analytics` · Kind: list · 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.custom_dimensions`
- 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. |
| `limit` | integer | no | 50 | 1–200 | Maximum number of results to return (1-200, default 50). |
| `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 |
|---|---|---|
| `propertyId` | string |  |
| `customDimensions` | object[] |  |
| `customDimensions[].id` | string | Custom dimension id (last part of name) |
| `customDimensions[].name` | string | "properties/123/customDimensions/456" |
| `customDimensions[].parameterName` | string | The event parameter (or user property / item parameter) it reads |
| `customDimensions[].displayName` | string \| null |  |
| `customDimensions[].description` | string \| null |  |
| `customDimensions[].scope` | string \| null | EVENT, USER or ITEM |
| `customDimensions[].apiName` | string \| null | Name to use in google-analytics.report: customEvent:<parameter>, customUser:<parameter> or customItem:<parameter> |
| `customDimensions[].disallowAdsPersonalization` | boolean |  |
| `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.custom_dimensions" \
  -H "Authorization: Bearer $PRIMARYAPI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"propertyId":"312345678"}'
```

## 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": {
      "propertyId": "312345678",
      "customDimensions": [
        {
          "id": "11223344",
          "name": "properties/312345678/customDimensions/11223344",
          "parameterName": "plan_type",
          "displayName": "Plan type",
          "description": "Pricing plan of the signed-in user",
          "scope": "EVENT",
          "apiName": "customEvent:plan_type",
          "disallowAdsPersonalization": false
        }
      ],
      "nextCursor": null
    }
  },
  "provider": "PrimaryAPI",
  "credits": 1,
  "items": 1,
  "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.custom_dimensions`

## 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). apiName is the name to report on it with google-analytics.report. Create one with google-analytics.create_custom_dimension. A property the account cannot see is a miss with reason no_access.

