Search Console Performance
Clicks, impressions, CTR and average position from Google Search for a Search Console property, grouped by query, page, country, device or date.
- Price per call
- 1 credit
- per successful call
- Price ceiling
- 1 credit
- every call, same price
- Failed calls
- Free
- retried automatically
- Billed
- Per call
- only on success
Endpoint
api.primaryapi.com/ v1/ run/ search-console. performanceAuth: API key with run or full access, or a dashboard session
Send the input below as a JSON body. The call is routed to a healthy upstream; if an attempt fails, it is retried automatically inside the same request and you pay only for the answer you get. To check an input and see the exact price without running anything, call POST /v1/quote/search-console.performance with the same body (free).
Example request
curl -sS -X POST "https://api.primaryapi.com/v1/run/search-console.performance" \
-H "Authorization: Bearer $PRIMARYAPI_API_KEY" \
-H "Content-Type: application/json" \
-d '{"siteUrl":"sc-domain:example.com","startDate":"2026-10-01","endDate":"2026-10-31","dimensions":["query"],"limit":2}'const res = await fetch('https://api.primaryapi.com/v1/run/search-console.performance', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.PRIMARYAPI_API_KEY}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
siteUrl: 'sc-domain:example.com',
startDate: '2026-10-01',
endDate: '2026-10-31',
dimensions: ['query'],
limit: 2,
}),
});
const body = await res.json();
if (!res.ok) throw new Error(`${body.code}: ${body.error}`);
// found:false is a successful answer ("does not exist"), not an error
console.log(body.output.found ? body.output.data : body.output.reason, body.credits);import os
import requests
res = requests.post(
"https://api.primaryapi.com/v1/run/search-console.performance",
headers={"Authorization": f"Bearer {os.environ['PRIMARYAPI_API_KEY']}"},
json={
"siteUrl": "sc-domain:example.com",
"startDate": "2026-10-01",
"endDate": "2026-10-31",
"dimensions": ["query"],
"limit": 2,
},
timeout=60,
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['code']}: {body['error']}")
# found=False is a successful answer ("does not exist"), not an error
print(body["output"]["data"] if body["output"]["found"] else body["output"]["reason"], body["credits"]){
"name": "run_api",
"arguments": {
"sku": "search-console.performance",
"input": {
"siteUrl": "sc-domain:example.com",
"startDate": "2026-10-01",
"endDate": "2026-10-31",
"dimensions": [
"query"
],
"limit": 2
}
}
}Price this exact input first (free)
curl -sS -X POST "https://api.primaryapi.com/v1/quote/search-console.performance" \
-H "Authorization: Bearer $PRIMARYAPI_API_KEY" \
-H "Content-Type: application/json" \
-d '{"siteUrl":"sc-domain:example.com","startDate":"2026-10-01","endDate":"2026-10-31","dimensions":["query"],"limit":2}'Returns credits (what the call is expected to cost) and maxCredits (the most it can cost, which is set aside while it runs). Invalid input fails here the same way it would on run.
Input
JSON body fields. Unknown fields are rejected with 400 invalid_input (never silently ignored). You may add the routing controls preferLatencyUnderMs and maxCredits to the same object.
siteUrlstringrequired- The Search Console property, exactly as search-console.sites lists it: "sc-domain:example.com" for a Domain property, or a URL-prefix property with its trailing slash, e.g. "https://www.example.com/".max 2048 chars
startDatestringrequired- First day of the range (YYYY-MM-DD, Pacific Time), inclusive.pattern: ^\d{4}-\d{2}-\d{2}$
endDatestringrequired- Last day of the range (YYYY-MM-DD, Pacific Time), inclusive; on or after startDate.pattern: ^\d{4}-\d{2}-\d{2}$
dimensionsenum[]default[]- Group rows by these, in this order: query, page, country, device, date, hour, searchAppearance, brandedClassification. Empty (default) = one total row.max 8 items
typeenumdefault"web"- Search type: web (default), image, video, news, discover, googleNews or webMultimodal.one of: web, image, video, news, discover, googleNews, webMultimodal
filtersobject[]- Filters that must ALL match (Search Console supports only AND between filters). Up to 20.max 20 items
filters[].dimensionenumrequired- Dimension to filter on.one of: query, page, country, device, searchAppearance, brandedClassification
filters[].operatorenumdefault"equals"- equals (default), notEquals, contains, notContains (case-insensitive), includingRegex or excludingRegex (RE2).one of: equals, notEquals, contains, notContains, includingRegex, excludingRegex
filters[].expressionstringrequired- Value to match: a query, a page URL, an ISO 3166-1 alpha-3 country ("usa"), DESKTOP/MOBILE/TABLET, a search appearance, or BRANDED/NON_BRANDED.max 4096 chars
aggregationTypeenumdefault"auto"- auto (default), byPage, byProperty or byNewsShowcasePanel. Grouping or filtering by page needs auto or byPage.one of: auto, byPage, byProperty, byNewsShowcasePanel
dataStateenumdefault"final"- final (default) = finished data only; all = include fresh data that may still change; hourly_all = with hourly rows (group by hour).one of: final, all, hourly_all
limitintegerdefault100- Maximum number of results to return (1-25000, default 100).1–25000
cursorstring- Opaque pagination cursor: pass the previous response's nextCursor.
connectionstring- 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.max 200 chars
Output
When output.found is true, output.data has these fields (a list under rows, billed per item returned).
rowsobject[]rows[].keysstring[]- Dimension values, in the order of `dimensions`
rows[].dimensionsobject- The same values by dimension name, e.g. { "query": "…" }
rows[].clicksnumberrows[].impressionsnumberrows[].ctrnumber- Click-through rate, 0 to 1
rows[].positionnumber- Average position in search results
aggregationTypestring | null- How Search Console aggregated the rows (auto, byPage, byProperty)
firstIncompleteDatestring | null- With dataState "all" grouped by date: values from this date on may still change
firstIncompleteHourstring | null- With dataState "hourly_all" grouped by hour: values from this hour on may still change
nextCursorstring | null
TypeScript type
/** output.data when output.found is true */
type SearchConsolePerformance = {
rows: {
/** Dimension values, in the order of `dimensions` */
keys: string[];
/** The same values by dimension name, e.g. { "query": "…" } */
dimensions: Record<string, unknown>;
clicks: number;
impressions: number;
/** Click-through rate, 0 to 1 */
ctr: number;
/** Average position in search results */
position: number;
}[];
/** How Search Console aggregated the rows (auto, byPage, byProperty) */
aggregationType: string | null;
/** With dataState "all" grouped by date: values from this date on may still change */
firstIncompleteDate: string | null;
/** With dataState "hourly_all" grouped by hour: values from this hour on may still change */
firstIncompleteHour: string | null;
nextCursor: string | null;
};If what you asked about does not exist, is private, or a search matches nothing, the call still succeeds: output.found is false, output.data is null and output.reason says why. Such misses are free unless the notes below say misses are billed, in which case a miss costs the price of one call.
Pagination. Pass the previous response’s nextCursor as cursor to get the next page. nextCursor: null means there is nothing more. See Pagination.
Example response
Values are placeholders that follow the output schema (strings as "string", numbers as 0); credits shows what this call would cost at the usual price.
{
"output": {
"found": true,
"data": {
"rows": [
{
"keys": [
"running shoes"
],
"dimensions": {
"query": "running shoes"
},
"clicks": 412,
"impressions": 9230,
"ctr": 0.0446,
"position": 6.8
},
{
"keys": [
"trail running shoes"
],
"dimensions": {
"query": "trail running shoes"
},
"clicks": 120,
"impressions": 4012,
"ctr": 0.0299,
"position": 9.1
}
],
"aggregationType": "byProperty",
"firstIncompleteDate": null,
"firstIncompleteHour": null,
"nextCursor": "eyJzIjoyfQ"
}
},
"provider": "PrimaryAPI",
"credits": 1,
"items": 2,
"requestId": "req_01JBXK6Y2N9V8T4R3Q2P1M0A7Z",
"nextCursor": null
}Pricing and reliability
Calls go only to upstreams that are healthy right now. If an attempt fails, the call is retried automatically inside the same request; a failed attempt costs nothing, and a call never costs more than its quote’s maxCredits. Live figures below are measured on real traffic.
Success rate, uptime, latency and call counts are measured live from real traffic over 30 days and show “—” until there is data.
Errors
Errors are JSON { code, error, requestId } and are never charged. The ones to handle for this endpoint:
- invalid_inputThe request failed validation before anything ran.
- unauthorizedNo valid API key or session was presented.
- insufficient_balanceThe balance cannot cover the most this call could cost.
- key_limit_reachedThe key’s own spend limit is used up for the current window.
- trial_cap_reachedAn agent trial key has used its whole trial budget.
- forbiddenThe credential is valid but may not do this.
- not_foundThe thing addressed by the URL does not exist for you.
- idempotency_conflictThe
Idempotency-Keyis already bound to a different request. - rate_limitedToo many requests in the current window.
- all_sources_failedThe call could not be answered, even after automatic retries.
- service_unavailableThis API cannot run in this deployment right now.
- timeoutThe request passed its deadline before it finished.
Notes
Runs as your connected Google account and needs the Read Search Console capability (search_console_read). Dates are Pacific Time. By default only finalized data is returned, so the most recent days can be missing; set dataState "all" to include fresh data that may still change. Page through with nextCursor (up to 25,000 rows per call). A property the account cannot see is a miss with reason no_access.
More Google Search Console endpoints
Generated from the PrimaryAPI catalog. Machine-readable contract: GET https://api.primaryapi.com/v1/apis/search-console.performance.