# Google Analytics Create Key Event (`google-analytics.create_key_event`)

Marks an event as a key event (conversion) in a Google Analytics 4 property (a change to the connected account).

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

- Endpoint: `POST https://api.primaryapi.com/v1/run/google-analytics.create_key_event`
- Category: Web Intelligence · Platform: `google-analytics` · Kind: lookup · 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.create_key_event`
- 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. |
| `eventName` | string | yes |  | max 100 chars; pattern: ^[A-Za-z][A-Za-z0-9_]*$ | The event to mark as a key event, exactly as it is collected (case sensitive), e.g. "sign_up". |
| `countingMethod` | enum | no | "ONCE_PER_EVENT" | one of: ONCE_PER_EVENT, ONCE_PER_SESSION | ONCE_PER_EVENT (default: every occurrence counts) or ONCE_PER_SESSION (at most once per session). |
| `defaultValue` | object | no |  |  | Optional value used when the event arrives without a value parameter. |
| `defaultValue.numericValue` | number | yes |  | ≥ 0 | Value of one key event. |
| `defaultValue.currencyCode` | string | yes |  | pattern: ^[A-Z]{3}$ | ISO 4217 currency of the value. |
| `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 |
|---|---|---|
| `id` | string | Key event id (last part of name) |
| `name` | string | "properties/123/keyEvents/456" |
| `eventName` | string | The event that counts as a key event (conversion) |
| `countingMethod` | string \| null | ONCE_PER_EVENT or ONCE_PER_SESSION |
| `defaultValue` | object \| null | Value used when the event has no value parameter |
| `defaultValue.numericValue` | number \| null |  |
| `defaultValue.currencyCode` | string \| null |  |
| `custom` | boolean \| null | False for key events Google created for you |
| `deletable` | boolean \| null |  |
| `createTime` | string \| null |  |
| `propertyId` | string |  |
| `created` | boolean | False when the event already was a key event (nothing was changed) |

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.

## Example request

```bash
curl -sS -X POST "https://api.primaryapi.com/v1/run/google-analytics.create_key_event" \
  -H "Authorization: Bearer $PRIMARYAPI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"propertyId":"312345678","eventName":"generate_lead"}'
```

## 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",
      "id": "6599990001",
      "name": "properties/312345678/keyEvents/6599990001",
      "eventName": "generate_lead",
      "countingMethod": "ONCE_PER_EVENT",
      "defaultValue": null,
      "custom": true,
      "deletable": true,
      "createTime": "2026-11-16T12:00:00.000Z",
      "created": true
    }
  },
  "provider": "PrimaryAPI",
  "credits": 1,
  "items": 1,
  "requestId": "req_01JBXK6Y2N9V8T4R3Q2P1M0A7Z"
}
```

## 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.create_key_event`

## 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

WRITE: changes the connected Google Analytics property: the event is marked as a key event (conversion) in its reports. Needs the Manage Google Analytics capability (analytics_manage) and edit access to the property. Safe to repeat: when the event already is a key event it is returned unchanged with created: false. A property the account cannot change is a miss with reason no_access and nothing changes.

