Analytics · Analytics

Get Google Business Profile search keywords

Fetches Google Business Profile search keywords.

GEThttps://api.pozy.ai/v1/analytics/googlebusiness/search-keywords

getGoogleBusinessSearchKeywords

Guides: Google Business Profile, Google Business management, Platform insights

Request

Send your API key as Authorization: Bearer pz_live_.... Read-only keys can call it. Keys with the analytics resource group disabled get 403 resource_group_disabled. Authentication

Query parameters

Name	Type	Notes
`accountId`required	string
`startMonth`	string	Matches `^\d{4}-\d{2}$`
`endMonth`	string	Matches `^\d{4}-\d{2}$`
`pageToken`	string

Example

curl -X GET "https://api.pozy.ai/v1/analytics/googlebusiness/search-keywords?accountId=696e0b682d0a31188e7a2ba9" \
  -H "Authorization: Bearer $POZY_API_KEY"

const res = await fetch("https://api.pozy.ai/v1/analytics/googlebusiness/search-keywords?accountId=696e0b682d0a31188e7a2ba9", {
  headers: { Authorization: `Bearer ${process.env.POZY_API_KEY}` },
});
const data = await res.json();
if (!res.ok) throw new Error(data?.error ?? `Request failed with status ${res.status}`);
console.log(data);

import os
import requests

resp = requests.get(
    "https://api.pozy.ai/v1/analytics/googlebusiness/search-keywords",
    headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
    params={
        "accountId": "696e0b682d0a31188e7a2ba9",
    },
    timeout=30,
)
resp.raise_for_status()
print(resp.json())

Response

200 on success

successboolean
accountIdstring
platformstring
monthRangeobject
- startMonthstring
- endMonthstring
keywordsarray of object
- keywordstring
- impressionsinteger
- impressionsThresholdinteger
  Can be null.
nextPageTokenstring
Can be null.
notestring

200 response

{
  "success": true,
  "accountId": "696e0b682d0a31188e7a2ba9",
  "platform": "instagram",
  "monthRange": {
    "startMonth": "string",
    "endMonth": "string"
  },
  "keywords": [
    {
      "keyword": "string",
      "impressions": 1,
      "impressionsThreshold": 1
    }
  ],
  "nextPageToken": "string",
  "note": "string"
}

Errors

Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:

400	invalid_request_error	A parameter or body field is missing or invalid. `param` names it.
401	authentication_error	The API key is missing, revoked or expired.
403	permission_error	The key is scoped to other profiles or has this resource group disabled.
429	rate_limit_error	Too many requests this minute. Wait for `Retry-After` seconds.

Every code is listed in Errors.

More in Analytics

GETGet post analytics GETAnalytics changed since a cursor GETGet YouTube channel insights GETGet LinkedIn org analytics GETGet TikTok account-level insights GETGet YouTube daily views GETGet YouTube video retention curve GETGet Facebook Page insights GETGet Facebook post monetization earnings GETGet Instagram insights GETGet Instagram follower history GETGet Facebook Page demographics GETGet LinkedIn organization follower demographics GETGet Instagram demographics GETGet Instagram online followers GETGet YouTube demographics GETGet daily aggregated metrics GETGet an analytics dashboard GETGet best times to post GETGet content performance decay GETGet frequency vs engagement GETGet post analytics timeline POSTRun a Google Analytics (GA4) report POSTRun a Google Analytics (GA4) realtime report GETList Google Analytics (GA4) dimensions and metrics GETList tracking windows POSTOpen a tracking window GETGet a tracking window DELCancel a tracking window GETGet post samples GETGet a post's authenticity score GETList authenticity scores GETGet Google Business Profile performance metrics POSTSync an external post GETGet LinkedIn aggregate stats GETGet LinkedIn post stats GETGet LinkedIn post reactions GETGet Facebook post reactions GETList visitor posts on a Facebook Page GETList the posts a Facebook Page is tagged in