Google Analytics Create Custom Dimension
Creates a custom dimension in a Google Analytics 4 property from an event parameter, user property or item parameter (a change to the connected account).
- 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. create_custom_dimensionAuth: 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.create_custom_dimension with the same body (free).
Example request
curl -sS -X POST "https://api.primaryapi.com/v1/run/google-analytics.create_custom_dimension" \
-H "Authorization: Bearer $PRIMARYAPI_API_KEY" \
-H "Content-Type: application/json" \
-d '{"propertyId":"312345678","parameterName":"article_author","displayName":"Article author","description":"Author of the article viewed","scope":"EVENT"}'const res = await fetch('https://api.primaryapi.com/v1/run/google-analytics.create_custom_dimension', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.PRIMARYAPI_API_KEY}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
propertyId: '312345678',
parameterName: 'article_author',
displayName: 'Article author',
description: 'Author of the article viewed',
scope: 'EVENT',
}),
});
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.create_custom_dimension",
headers={"Authorization": f"Bearer {os.environ['PRIMARYAPI_API_KEY']}"},
json={
"propertyId": "312345678",
"parameterName": "article_author",
"displayName": "Article author",
"description": "Author of the article viewed",
"scope": "EVENT",
},
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.create_custom_dimension",
"input": {
"propertyId": "312345678",
"parameterName": "article_author",
"displayName": "Article author",
"description": "Author of the article viewed",
"scope": "EVENT"
}
}
}Price this exact input first (free)
curl -sS -X POST "https://api.primaryapi.com/v1/quote/google-analytics.create_custom_dimension" \
-H "Authorization: Bearer $PRIMARYAPI_API_KEY" \
-H "Content-Type: application/json" \
-d '{"propertyId":"312345678","parameterName":"article_author","displayName":"Article author","description":"Author of the article viewed","scope":"EVENT"}'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})$
parameterNamestringrequired- The event parameter (EVENT), user property (USER) or item parameter (ITEM) to report on, e.g. "plan_type". Max 40 characters, 24 for USER.max 40 chars · pattern: ^[A-Za-z][A-Za-z0-9_]*$
displayNamestringrequired- Name shown in Google Analytics reports, e.g. "Plan type" (max 82 characters).max 82 chars · pattern: ^[A-Za-z][A-Za-z0-9_ ]*$
descriptionstring- Optional description (max 150 characters).max 150 chars
scopeenumrequired- EVENT (an event parameter), USER (a user property) or ITEM (an e-commerce item parameter). Cannot be changed later.one of: EVENT, USER, ITEM
disallowAdsPersonalizationboolean- USER scope only: exclude this dimension from ads personalization.
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.
idstring- Custom dimension id (last part of name)
namestring- "properties/123/customDimensions/456"
parameterNamestring- The event parameter (or user property / item parameter) it reads
displayNamestring | nulldescriptionstring | nullscopestring | null- EVENT, USER or ITEM
apiNamestring | null- Name to use in google-analytics.report: customEvent:<parameter>, customUser:<parameter> or customItem:<parameter>
disallowAdsPersonalizationbooleanpropertyIdstringcreatedboolean- False when the property already had this dimension (nothing was changed)
TypeScript type
/** output.data when output.found is true */
type GoogleAnalyticsCreateCustomDimension = {
/** Custom dimension id (last part of name) */
id: string;
/** "properties/123/customDimensions/456" */
name: string;
/** The event parameter (or user property / item parameter) it reads */
parameterName: string;
displayName: string | null;
description: string | null;
/** EVENT, USER or ITEM */
scope: string | null;
/** Name to use in google-analytics.report: customEvent:<parameter>, customUser:<parameter> or customItem:<parameter> */
apiName: string | null;
disallowAdsPersonalization: boolean;
propertyId: string;
/** False when the property already had this dimension (nothing was changed) */
created: boolean;
};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.
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": {
"propertyId": "312345678",
"id": "11229900",
"name": "properties/312345678/customDimensions/11229900",
"parameterName": "article_author",
"displayName": "Article author",
"description": "Author of the article viewed",
"scope": "EVENT",
"apiName": "customEvent:article_author",
"disallowAdsPersonalization": false,
"created": true
}
},
"provider": "PrimaryAPI",
"credits": 1,
"items": 1,
"requestId": "req_01JBXK6Y2N9V8T4R3Q2P1M0A7Z"
}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
WRITE: changes the connected Google Analytics property. Needs the Manage Google Analytics capability (analytics_manage) and edit access to the property. A custom dimension cannot be deleted through the API, only archived, and properties have a limited number of them, so create only what you will report on. scope and parameterName cannot be changed later. Safe to repeat: an existing dimension with the same scope and parameterName is returned unchanged with created: false. A property the account cannot change is a miss with reason no_access and nothing changes.
More Google Analytics endpoints
Generated from the PrimaryAPI catalog. Machine-readable contract: GET https://api.primaryapi.com/v1/apis/google-analytics.create_custom_dimension.