Google Analytics Report
Runs a Google Analytics 4 report for a property: any dimensions and metrics over date ranges, with filters, sorting and paging.
- 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/ google-analytics. reportAuth: 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/google-analytics.report with the same body (free).
Example request
curl -sS -X POST "https://api.primaryapi.com/v1/run/google-analytics.report" \
-H "Authorization: Bearer $PRIMARYAPI_API_KEY" \
-H "Content-Type: application/json" \
-d '{"propertyId":"312345678","dimensions":["sessionDefaultChannelGroup"],"metrics":["sessions","engagementRate"],"orderBys":[{"metric":{"metricName":"sessions"},"desc":true}],"limit":2}'const res = await fetch('https://api.primaryapi.com/v1/run/google-analytics.report', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.PRIMARYAPI_API_KEY}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
propertyId: '312345678',
dimensions: ['sessionDefaultChannelGroup'],
metrics: ['sessions', 'engagementRate'],
orderBys: [{
metric: {
metricName: 'sessions',
},
desc: true,
}],
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/google-analytics.report",
headers={"Authorization": f"Bearer {os.environ['PRIMARYAPI_API_KEY']}"},
json={
"propertyId": "312345678",
"dimensions": ["sessionDefaultChannelGroup"],
"metrics": ["sessions", "engagementRate"],
"orderBys": [{
"metric": {
"metricName": "sessions",
},
"desc": True,
}],
"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": "google-analytics.report",
"input": {
"propertyId": "312345678",
"dimensions": [
"sessionDefaultChannelGroup"
],
"metrics": [
"sessions",
"engagementRate"
],
"orderBys": [
{
"metric": {
"metricName": "sessions"
},
"desc": true
}
],
"limit": 2
}
}
}Price this exact input first (free)
curl -sS -X POST "https://api.primaryapi.com/v1/quote/google-analytics.report" \
-H "Authorization: Bearer $PRIMARYAPI_API_KEY" \
-H "Content-Type: application/json" \
-d '{"propertyId":"312345678","dimensions":["sessionDefaultChannelGroup"],"metrics":["sessions","engagementRate"],"orderBys":[{"metric":{"metricName":"sessions"},"desc":true}],"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.
propertyIdstringrequired- GA4 property id, e.g. "123456789" (or "properties/123456789"), as google-analytics.properties lists it.pattern: ^(?:properties\/)?(\d{1,20})$
dateRangesobject[]default[{"startDate":"28daysAgo","endDate":"yesterday"}]- Date ranges (1-4). Default: the last 28 days up to yesterday.min 1 items · max 4 items
dateRanges[].startDatestringrequired- First day: YYYY-MM-DD, NdaysAgo, yesterday or today (property time zone).pattern: ^(?:\d{4}-\d{2}-\d{2}|\d{1,4}daysAgo|yesterday|today)$
dateRanges[].endDatestringrequired- Last day, inclusive: YYYY-MM-DD, NdaysAgo, yesterday or today.pattern: ^(?:\d{4}-\d{2}-\d{2}|\d{1,4}daysAgo|yesterday|today)$
dateRanges[].namestring- Optional name, returned in the dateRange dimension when several ranges are requested.max 100 chars
dimensionsstring[]default[]- Dimensions to group by (API names, up to 9), e.g. ["date", "sessionDefaultChannelGroup"]. List them with google-analytics.metadata.max 9 items · items max 200 chars · items pattern: ^[A-Za-z][A-Za-z0-9_:]*(?:\[[A-Za-z0-9_]+\])?$
metricsstring[]required- Metrics to return (API names, 1-10), e.g. ["activeUsers", "sessions", "keyEvents"]. List them with google-analytics.metadata.min 1 items · max 10 items · items max 200 chars · items pattern: ^[A-Za-z][A-Za-z0-9_:]*(?:\[[A-Za-z0-9_]+\])?$
dimensionFilterobject- Optional GA4 FilterExpression on dimensions, e.g. {"filter":{"fieldName":"country","stringFilter":{"matchType":"EXACT","value":"France"}}}; combine with andGroup / orGroup / notExpression.
metricFilterobject- Optional GA4 FilterExpression on metrics, applied after aggregation, e.g. {"filter":{"fieldName":"sessions","numericFilter":{"operation":"GREATER_THAN","value":{"int64Value":"100"}}}}.
orderBysobject[]- Sort order, e.g. [{"metric":{"metricName":"sessions"},"desc":true}].max 10 items
orderBys[].metricobjectorderBys[].dimensionobjectorderBys[].descboolean- Descending when true
metricAggregationsenum[]- Also return totals / minimums / maximums / counts of the metrics.max 4 items
currencyCodestring- ISO 4217 currency for revenue metrics (default: the property’s currency).pattern: ^[A-Z]{3}$
keepEmptyRowsbooleandefaultfalse- Keep rows whose metrics are all 0 (default false).
limitintegerdefault100- Maximum number of results to return (1-10000, default 100).1–10000
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[].dimensionsobject- Dimension values by API name
rows[].metricsobject- Metric values by API name (numbers)
dimensionHeadersstring[]metricHeadersobject[]metricHeaders[].namestringmetricHeaders[].typestring | null- TYPE_INTEGER, TYPE_CURRENCY, …
totalsobject[]totals[].dimensionsobject- Dimension values by API name
totals[].metricsobject- Metric values by API name (numbers)
maximumsobject[]maximums[].dimensionsobject- Dimension values by API name
maximums[].metricsobject- Metric values by API name (numbers)
minimumsobject[]minimums[].dimensionsobject- Dimension values by API name
minimums[].metricsobject- Metric values by API name (numbers)
rowCountinteger | null- Rows in the whole result, regardless of limit
propertyQuotaobject | null- The property’s Data API quota after this call (tokensPerDay, tokensPerHour, …)
metadataobjectmetadata.currencyCodestring | nullmetadata.timeZonestring | nullmetadata.subjectToThresholdingboolean- Some rows were withheld by Google’s privacy thresholds
metadata.dataLossFromOtherRowboolean- Some values were grouped into "(other)"
metadata.sampledboolean- The report is based on a sample of events
metadata.emptyReasonstring | nullnextCursorstring | null
TypeScript type
/** output.data when output.found is true */
type GoogleAnalyticsReport = {
rows: {
/** Dimension values by API name */
dimensions: Record<string, unknown>;
/** Metric values by API name (numbers) */
metrics: Record<string, unknown>;
}[];
dimensionHeaders: string[];
metricHeaders: {
name: string;
/** TYPE_INTEGER, TYPE_CURRENCY, … */
type: string | null;
}[];
totals: {
/** Dimension values by API name */
dimensions: Record<string, unknown>;
/** Metric values by API name (numbers) */
metrics: Record<string, unknown>;
}[];
maximums: {
/** Dimension values by API name */
dimensions: Record<string, unknown>;
/** Metric values by API name (numbers) */
metrics: Record<string, unknown>;
}[];
minimums: {
/** Dimension values by API name */
dimensions: Record<string, unknown>;
/** Metric values by API name (numbers) */
metrics: Record<string, unknown>;
}[];
/** Rows in the whole result, regardless of limit */
rowCount: number | null;
/** The property’s Data API quota after this call (tokensPerDay, tokensPerHour, …) */
propertyQuota: Record<string, unknown> | null;
metadata: {
currencyCode: string | null;
timeZone: string | null;
/** Some rows were withheld by Google’s privacy thresholds */
subjectToThresholding: boolean;
/** Some values were grouped into "(other)" */
dataLossFromOtherRow: boolean;
/** The report is based on a sample of events */
sampled: boolean;
emptyReason: 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": [
{
"dimensions": {
"sessionDefaultChannelGroup": "Organic Search"
},
"metrics": {
"sessions": 5120,
"engagementRate": 0.6312
}
},
{
"dimensions": {
"sessionDefaultChannelGroup": "Direct"
},
"metrics": {
"sessions": 2210,
"engagementRate": 0.5544
}
}
],
"dimensionHeaders": [
"sessionDefaultChannelGroup"
],
"metricHeaders": [
{
"name": "sessions",
"type": "TYPE_INTEGER"
},
{
"name": "engagementRate",
"type": "TYPE_FLOAT"
}
],
"totals": [],
"maximums": [],
"minimums": [],
"rowCount": 6,
"propertyQuota": {
"tokensPerDay": {
"consumed": 12,
"remaining": 199870
},
"tokensPerHour": {
"consumed": 12,
"remaining": 39950
},
"concurrentRequests": {
"consumed": null,
"remaining": 10
},
"serverErrorsPerProjectPerHour": {
"consumed": null,
"remaining": 10
},
"potentiallyThresholdedRequestsPerHour": {
"consumed": null,
"remaining": 120
},
"tokensPerProjectPerHour": {
"consumed": 12,
"remaining": 13970
}
},
"metadata": {
"currencyCode": "USD",
"timeZone": "America/Los_Angeles",
"subjectToThresholding": false,
"dataLossFromOtherRow": false,
"sampled": false,
"emptyReason": null
},
"nextCursor": "eyJvIjoyfQ"
}
},
"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 Google Analytics capability (analytics_read). Uses the GA4 Data API: dimension and metric API names come from google-analytics.metadata (custom ones look like "customEvent:plan_type"). Each call spends the property’s own Data API quota (shown in propertyQuota); when it runs out Google answers with a rate limit until the quota refills. With several date ranges each row also carries its date range (index or name).
More Google Analytics endpoints
Generated from the PrimaryAPI catalog. Machine-readable contract: GET https://api.primaryapi.com/v1/apis/google-analytics.report.