# Google Business Profile Search Keywords (`google-business.search_keywords`)

The searches on Google Search and Maps that showed one of your business locations, with monthly unique-user impressions per keyword.

Docs: https://primaryapi.com/docs/api-reference/google-business/search_keywords

- Endpoint: `POST https://api.primaryapi.com/v1/run/google-business.search_keywords`
- Category: Search & SEO · Platform: `google-business` · 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-business.search_keywords`
- Execution: synchronous (answers 202 only if it outlives the wait window)

## Input

| Field | Type | Required | Default | Constraints | Description |
|---|---|---|---|---|---|
| `locationId` | string | yes |  | pattern: ^(?:(?:accounts\/[A-Za-z0-9_-]{1,64}\/)?locations\/)?([A-Za-z0-9_-]{1,64})$ | Business Profile location id, e.g. "9876543210" (or "locations/9876543210"), as google-business.locations lists it. |
| `startMonth` | string | yes |  | pattern: ^(\d{4})-(0[1-9]\|1[0-2])$ | First month (YYYY-MM), inclusive. |
| `endMonth` | string | yes |  | pattern: ^(\d{4})-(0[1-9]\|1[0-2])$ | Last month (YYYY-MM), inclusive. |
| `limit` | integer | no | 100 | 1–100 | Maximum number of results to return (1-100, 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 |
|---|---|---|
| `locationId` | string |  |
| `startMonth` | string |  |
| `endMonth` | string |  |
| `keywords` | object[] |  |
| `keywords[].keyword` | string | What people searched for (lower-cased) |
| `keywords[].impressions` | integer \| null | Unique users who searched it and saw the profile, summed per month over the range; null when only a threshold is given |
| `keywords[].impressionsBelow` | integer \| null | When Google withholds a small count: the real value is below this number |
| `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-business.search_keywords" \
  -H "Authorization: Bearer $PRIMARYAPI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"locationId":"9876543210","startMonth":"2026-08","endMonth":"2026-10"}'
```

## 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": {
      "locationId": "9876543210",
      "startMonth": "2026-08",
      "endMonth": "2026-10",
      "keywords": [
        {
          "keyword": "coffee near me",
          "impressions": 842,
          "impressionsBelow": null
        },
        {
          "keyword": "example coffee",
          "impressions": 311,
          "impressionsBelow": null
        },
        {
          "keyword": "oat milk latte mission",
          "impressions": null,
          "impressionsBelow": 15
        }
      ],
      "nextCursor": null
    }
  },
  "provider": "PrimaryAPI",
  "credits": 1,
  "items": 3,
  "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-business.search_keywords`

## 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 Google Business Profile capability (business_profile). Get locationId from google-business.locations. Months are inclusive; counts are unique users per month, summed over the range. Small counts come back only as a threshold (impressionsBelow). No keywords for the range is a miss (no_keywords); an unknown location location_not_found. Google grants Business Profile API access per Cloud project, on request: until it has granted PrimaryAPI’s, calls are refused (as a permission error, never charged).

