{ "openapi": "3.1.0", "info": { "title": "MetricsGo API", "version": "1.0.0", "description": "Read access to the Meta ads, organic social, website (Google Analytics and Search Console) and Shopify store data MetricsGo has synced for your organisation. All numbers are stored data — the API never calls Meta on your behalf; check meta.syncedAt for freshness. Meta ads and social dates are IST calendar days; the Google and Shopify surfaces keep the source platform's own day boundary. Ranges may not exceed 366 days. null means \"not reported\", never zero. Keys must be sent as Authorization: Bearer from a server — this API sends no CORS headers on purpose." }, "servers": [ { "url": "https://metricsgo.srv1821420.hstgr.cloud/api/v1" } ], "components": { "securitySchemes": { "apiKey": { "type": "http", "scheme": "bearer", "bearerFormat": "mg_live_…" } }, "schemas": { "Problem": { "type": "object", "required": [ "type", "title", "status", "detail", "code" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string", "enum": [ "unauthorized", "forbidden", "not_found", "validation_failed", "rate_limited", "unavailable", "internal" ] }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "Meta": { "type": "object", "properties": { "from": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "to": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "timezone": { "type": "string", "const": "Asia/Kolkata" }, "syncedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "truncated": { "type": "boolean" }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "timezone", "syncedAt" ], "additionalProperties": false } } }, "paths": { "/me": { "get": { "summary": "The calling key: org, scopes, client restriction", "security": [ { "apiKey": [] } ], "x-scope": null, "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "meta" ], "properties": { "data": { "type": "object", "properties": { "key": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "prefix": { "type": "string" }, "expiresAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "name", "prefix", "expiresAt" ], "additionalProperties": false }, "org": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false }, "scopes": { "type": "array", "items": { "type": "string" } }, "clientIds": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "key", "org", "scopes", "clientIds" ], "additionalProperties": false }, "meta": { "type": "object", "properties": { "from": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "to": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "timezone": { "type": "string", "const": "Asia/Kolkata" }, "syncedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "truncated": { "type": "boolean" }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "timezone", "syncedAt" ], "additionalProperties": false } } } } } }, "400": { "description": "Invalid query", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Key lacks the required scope", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found in this organisation", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limited (60 requests per minute per key)", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/clients": { "get": { "summary": "Clients this key can read, with their ad accounts, Pages, Analytics properties, Search Console sites and Shopify stores", "security": [ { "apiKey": [] } ], "x-scope": null, "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "meta" ], "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "adAccounts": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "platformAccountId": { "type": "string" }, "name": { "type": "string" }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "lastSyncedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "platformAccountId", "name", "currency", "lastSyncedAt" ], "additionalProperties": false } }, "pages": { "type": "array", "items": { "type": "object", "properties": { "pageId": { "type": "string" }, "name": { "type": "string" }, "igUsername": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "pageId", "name", "igUsername" ], "additionalProperties": false } }, "analyticsProperties": { "type": "array", "items": { "type": "object", "properties": { "propertyId": { "type": "string" }, "name": { "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "lastSyncedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "propertyId", "name", "timezone", "lastSyncedAt" ], "additionalProperties": false } }, "searchConsoleSites": { "type": "array", "items": { "type": "object", "properties": { "siteUrl": { "type": "string" }, "lastSyncedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "siteUrl", "lastSyncedAt" ], "additionalProperties": false } }, "shopifyStores": { "type": "array", "items": { "type": "object", "properties": { "shopDomain": { "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "lastSyncedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "shopDomain", "name", "currency", "timezone", "lastSyncedAt" ], "additionalProperties": false } } }, "required": [ "id", "name", "adAccounts", "pages", "analyticsProperties", "searchConsoleSites", "shopifyStores" ], "additionalProperties": false } }, "meta": { "type": "object", "properties": { "from": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "to": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "timezone": { "type": "string", "const": "Asia/Kolkata" }, "syncedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "truncated": { "type": "boolean" }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "timezone", "syncedAt" ], "additionalProperties": false } } } } } }, "400": { "description": "Invalid query", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Key lacks the required scope", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found in this organisation", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limited (60 requests per minute per key)", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/ads/overview": { "get": { "summary": "Ads overview: KPIs, previous period, daily series, funds, widgets", "security": [ { "apiKey": [] } ], "x-scope": "ads:read", "parameters": [ { "name": "client", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "from", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, { "name": "to", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, { "name": "campaignId", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 64 } }, { "name": "adSetId", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 64 } }, { "name": "adId", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 64 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "meta" ], "properties": { "data": { "type": "object", "properties": { "kpis": { "type": "object", "properties": { "spend": { "type": "number" }, "impressions": { "type": "number" }, "reach": { "type": "number" }, "clicks": { "type": "number" }, "ctr": { "type": "number" }, "cpc": { "type": "number" }, "videoViews": { "type": "number" }, "purchaseValue": { "type": "number" }, "results": { "type": "number" }, "resultType": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "costPerResult": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "spend", "impressions", "reach", "clicks", "ctr", "cpc", "videoViews", "purchaseValue", "results", "resultType", "costPerResult" ], "additionalProperties": false }, "previous": { "type": "object", "properties": { "spend": { "type": "number" }, "results": { "type": "number" }, "impressions": { "type": "number" }, "clicks": { "type": "number" }, "reach": { "type": "number" } }, "required": [ "spend", "results", "impressions", "clicks", "reach" ], "additionalProperties": false }, "funds": { "type": "object", "properties": { "balance": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "spent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "cap": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "balance", "spent", "cap" ], "additionalProperties": false }, "lowBalance": { "type": "array", "items": { "type": "object", "properties": { "accountName": { "type": "string" }, "balance": { "type": "number" }, "threshold": { "type": "number" }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "accountName", "balance", "threshold", "currency" ], "additionalProperties": false } }, "series": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "spend": { "type": "number" }, "impressions": { "type": "number" }, "clicks": { "type": "number" }, "reach": { "type": "number" }, "results": { "type": "number" } }, "required": [ "date", "spend", "impressions", "clicks", "reach", "results" ], "additionalProperties": false } }, "campaigns": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "effectiveStatus": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "spend": { "type": "number" }, "impressions": { "type": "number" }, "clicks": { "type": "number" }, "ctr": { "type": "number" }, "account": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "platformAccountId": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "platformAccountId", "name" ], "additionalProperties": false }, { "type": "null" } ] }, "client": { "anyOf": [ { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "id", "name", "status", "effectiveStatus", "spend", "impressions", "clicks", "ctr", "account", "client" ], "additionalProperties": false } }, "widgets": { "type": "object", "properties": { "funnel": { "type": "object", "properties": { "impressions": { "type": "number" }, "reach": { "type": "number" }, "clicks": { "type": "number" }, "linkClicks": { "type": "number" }, "results": { "type": "number" }, "resultType": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "impressions", "reach", "clicks", "linkClicks", "results", "resultType" ], "additionalProperties": false }, "topCampaigns": { "type": "array", "items": { "type": "object", "properties": { "platformId": { "type": "string" }, "name": { "type": "string" }, "spend": { "type": "number" }, "results": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "resultType": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "costPerResult": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "ctr": { "type": "number" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "platformId", "name", "spend", "results", "resultType", "costPerResult", "ctr", "status" ], "additionalProperties": false } }, "ageGender": { "type": "array", "items": { "type": "object", "properties": { "age": { "type": "string" }, "gender": { "type": "string" }, "impressions": { "type": "number" }, "clicks": { "type": "number" }, "spend": { "type": "number" }, "reach": { "type": "number" } }, "required": [ "age", "gender", "impressions", "clicks", "spend", "reach" ], "additionalProperties": false } }, "platforms": { "type": "array", "items": { "type": "object", "properties": { "platform": { "type": "string" }, "impressions": { "type": "number" }, "spend": { "type": "number" }, "clicks": { "type": "number" } }, "required": [ "platform", "impressions", "spend", "clicks" ], "additionalProperties": false } }, "placements": { "type": "array", "items": { "type": "object", "properties": { "platform": { "type": "string" }, "position": { "type": "string" }, "impressions": { "type": "number" }, "spend": { "type": "number" }, "clicks": { "type": "number" } }, "required": [ "platform", "position", "impressions", "spend", "clicks" ], "additionalProperties": false } }, "video": { "type": "object", "properties": { "views3s": { "type": "number" }, "thruplay": { "type": "number" }, "p25": { "type": "number" }, "p50": { "type": "number" }, "p75": { "type": "number" }, "p100": { "type": "number" } }, "required": [ "views3s", "thruplay", "p25", "p50", "p75", "p100" ], "additionalProperties": false } }, "required": [ "funnel", "topCampaigns", "ageGender", "platforms", "placements", "video" ], "additionalProperties": false } }, "required": [ "kpis", "previous", "funds", "lowBalance", "series", "campaigns", "widgets" ], "additionalProperties": false }, "meta": { "type": "object", "properties": { "from": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "to": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "timezone": { "type": "string", "const": "Asia/Kolkata" }, "syncedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "truncated": { "type": "boolean" }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "timezone", "syncedAt" ], "additionalProperties": false } } } } } }, "400": { "description": "Invalid query", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Key lacks the required scope", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found in this organisation", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limited (60 requests per minute per key)", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/ads/entities": { "get": { "summary": "Campaigns, ad sets or ads with range totals (capped at 500; see meta.truncated)", "security": [ { "apiKey": [] } ], "x-scope": "ads:read", "parameters": [ { "name": "level", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "campaign", "adset", "ad" ] } }, { "name": "client", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "from", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, { "name": "to", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 100 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "meta" ], "properties": { "data": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "platformId": { "type": "string" }, "name": { "type": "string" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "effectiveStatus": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "spend": { "type": "number" }, "impressions": { "type": "number" }, "reach": { "type": "number" }, "clicks": { "type": "number" }, "linkClicks": { "type": "number" }, "results": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "resultType": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ctr": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "cpc": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "costPerResult": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "frequency": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "thumbnailUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "imageUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "account": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "platformAccountId": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "platformAccountId", "name" ], "additionalProperties": false }, { "type": "null" } ] }, "client": { "anyOf": [ { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false }, { "type": "null" } ] }, "campaign": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "platformId": { "type": "string" }, "name": { "type": "string" }, "objective": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "platformId", "name", "objective" ], "additionalProperties": false }, { "type": "null" } ] }, "adSet": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "platformId": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "platformId", "name" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "id", "platformId", "name", "status", "effectiveStatus", "currency", "spend", "impressions", "reach", "clicks", "linkClicks", "results", "resultType", "ctr", "cpc", "costPerResult", "frequency", "account", "client", "campaign", "adSet" ], "additionalProperties": false } }, "truncated": { "type": "boolean" } }, "required": [ "rows", "truncated" ], "additionalProperties": false }, "meta": { "type": "object", "properties": { "from": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "to": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "timezone": { "type": "string", "const": "Asia/Kolkata" }, "syncedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "truncated": { "type": "boolean" }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "timezone", "syncedAt" ], "additionalProperties": false } } } } } }, "400": { "description": "Invalid query", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Key lacks the required scope", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found in this organisation", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limited (60 requests per minute per key)", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/ads/breakdowns": { "get": { "summary": "Age/gender, device, platform, placement and region for one entity (cached data only; see stale)", "security": [ { "apiKey": [] } ], "x-scope": "ads:read", "parameters": [ { "name": "level", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "campaign", "adset", "ad" ] } }, { "name": "entityId", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 64 } }, { "name": "from", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, { "name": "to", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "meta" ], "properties": { "data": { "type": "object", "properties": { "ageGender": { "type": "array", "items": { "type": "object", "properties": { "key1": { "type": "string" }, "key2": { "type": "string" }, "spend": { "type": "number" }, "impressions": { "type": "number" }, "clicks": { "type": "number" }, "reach": { "type": "number" } }, "required": [ "key1", "key2", "spend", "impressions", "clicks", "reach" ], "additionalProperties": false } }, "device": { "type": "array", "items": { "type": "object", "properties": { "key1": { "type": "string" }, "key2": { "type": "string" }, "spend": { "type": "number" }, "impressions": { "type": "number" }, "clicks": { "type": "number" }, "reach": { "type": "number" } }, "required": [ "key1", "key2", "spend", "impressions", "clicks", "reach" ], "additionalProperties": false } }, "platform": { "type": "array", "items": { "type": "object", "properties": { "key1": { "type": "string" }, "key2": { "type": "string" }, "spend": { "type": "number" }, "impressions": { "type": "number" }, "clicks": { "type": "number" }, "reach": { "type": "number" } }, "required": [ "key1", "key2", "spend", "impressions", "clicks", "reach" ], "additionalProperties": false } }, "placement": { "type": "array", "items": { "type": "object", "properties": { "key1": { "type": "string" }, "key2": { "type": "string" }, "spend": { "type": "number" }, "impressions": { "type": "number" }, "clicks": { "type": "number" }, "reach": { "type": "number" } }, "required": [ "key1", "key2", "spend", "impressions", "clicks", "reach" ], "additionalProperties": false } }, "region": { "type": "array", "items": { "type": "object", "properties": { "key1": { "type": "string" }, "key2": { "type": "string" }, "spend": { "type": "number" }, "impressions": { "type": "number" }, "clicks": { "type": "number" }, "reach": { "type": "number" } }, "required": [ "key1", "key2", "spend", "impressions", "clicks", "reach" ], "additionalProperties": false } }, "syncedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "stale": { "type": "boolean" } }, "required": [ "ageGender", "device", "platform", "placement", "region", "syncedAt", "stale" ], "additionalProperties": false }, "meta": { "type": "object", "properties": { "from": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "to": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "timezone": { "type": "string", "const": "Asia/Kolkata" }, "syncedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "truncated": { "type": "boolean" }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "timezone", "syncedAt" ], "additionalProperties": false } } } } } }, "400": { "description": "Invalid query", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Key lacks the required scope", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found in this organisation", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limited (60 requests per minute per key)", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/social/overview": { "get": { "summary": "Facebook Page and Instagram totals, previous period and daily series", "security": [ { "apiKey": [] } ], "x-scope": "social:read", "parameters": [ { "name": "client", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "from", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, { "name": "to", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "meta" ], "properties": { "data": { "type": "object", "properties": { "from": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "to": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "previousFrom": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "previousTo": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "platforms": { "type": "array", "items": { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "facebook", "instagram" ] }, "totals": { "type": "object", "properties": { "reach": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "impressions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "views": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "profileViews": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "interactions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "newFollows": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "followers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "engagementRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "reach", "impressions", "views", "profileViews", "interactions", "newFollows", "followers", "engagementRate" ], "additionalProperties": false }, "previousTotals": { "type": "object", "properties": { "reach": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "impressions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "views": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "profileViews": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "interactions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "newFollows": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "followers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "engagementRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "reach", "impressions", "views", "profileViews", "interactions", "newFollows", "followers", "engagementRate" ], "additionalProperties": false }, "postTotals": { "type": "object", "properties": { "newPosts": { "type": "number" }, "likes": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "comments": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "shares": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "saves": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "newPosts", "likes", "comments", "shares", "saves" ], "additionalProperties": false }, "previousPostTotals": { "type": "object", "properties": { "newPosts": { "type": "number" }, "likes": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "comments": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "shares": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "saves": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "newPosts", "likes", "comments", "shares", "saves" ], "additionalProperties": false }, "series": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "reach": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "impressions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "views": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "interactions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "newFollows": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "followers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "date", "reach", "impressions", "views", "interactions", "newFollows", "followers" ], "additionalProperties": false } }, "pageCount": { "type": "number" } }, "required": [ "platform", "totals", "previousTotals", "postTotals", "previousPostTotals", "series", "pageCount" ], "additionalProperties": false } }, "pages": { "type": "array", "items": { "type": "object", "properties": { "pageId": { "type": "string" }, "name": { "type": "string" }, "igUsername": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "pageId", "name", "igUsername" ], "additionalProperties": false } } }, "required": [ "from", "to", "previousFrom", "previousTo", "platforms", "pages" ], "additionalProperties": false }, "meta": { "type": "object", "properties": { "from": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "to": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "timezone": { "type": "string", "const": "Asia/Kolkata" }, "syncedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "truncated": { "type": "boolean" }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "timezone", "syncedAt" ], "additionalProperties": false } } } } } }, "400": { "description": "Invalid query", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Key lacks the required scope", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found in this organisation", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limited (60 requests per minute per key)", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/social/posts": { "get": { "summary": "Posts published in the range with per-post metrics (newest first)", "security": [ { "apiKey": [] } ], "x-scope": "social:read", "parameters": [ { "name": "client", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "from", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, { "name": "to", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, { "name": "limit", "in": "query", "required": false, "schema": { "default": 100, "type": "integer", "minimum": 1, "maximum": 500 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "meta" ], "properties": { "data": { "type": "object", "properties": { "posts": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "platform": { "type": "string", "enum": [ "facebook", "instagram" ] }, "postId": { "type": "string" }, "caption": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "mediaType": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "permalink": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "thumbnailHref": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "publishedAt": { "type": "string" }, "likes": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "comments": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "shares": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "saves": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "views": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "reach": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "impressions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "engagementRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "id", "platform", "postId", "caption", "mediaType", "permalink", "thumbnailHref", "publishedAt", "likes", "comments", "shares", "saves", "views", "reach", "impressions", "engagementRate" ], "additionalProperties": false } }, "truncated": { "type": "boolean" } }, "required": [ "posts", "truncated" ], "additionalProperties": false }, "meta": { "type": "object", "properties": { "from": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "to": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "timezone": { "type": "string", "const": "Asia/Kolkata" }, "syncedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "truncated": { "type": "boolean" }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "timezone", "syncedAt" ], "additionalProperties": false } } } } } }, "400": { "description": "Invalid query", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Key lacks the required scope", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found in this organisation", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limited (60 requests per minute per key)", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/website/overview": { "get": { "summary": "Google Analytics: totals, previous period, daily series and the channel, source, landing page, event, device and country tables", "description": "GA4 days follow the property’s own timezone, not IST. data.analytics is null when no property is attached.", "security": [ { "apiKey": [] } ], "x-scope": "web:read", "parameters": [ { "name": "client", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "from", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, { "name": "to", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, { "name": "compare", "in": "query", "required": false, "schema": { "default": "previous", "type": "string", "enum": [ "previous", "prevMonth", "prevYear", "none" ] } }, { "name": "limit", "in": "query", "required": false, "schema": { "default": 25, "type": "integer", "minimum": 1, "maximum": 100 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "meta" ], "properties": { "data": { "type": "object", "properties": { "from": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "to": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "compare": { "anyOf": [ { "type": "object", "properties": { "from": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "to": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, "required": [ "from", "to" ], "additionalProperties": false }, { "type": "null" } ] }, "analytics": { "anyOf": [ { "type": "object", "properties": { "properties": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "lastSyncedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "name", "timezone", "lastSyncedAt" ], "additionalProperties": false } }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "totals": { "type": "object", "properties": { "sessions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "totalUsers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "activeUsers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "newUsers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "engagedSessions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "screenPageViews": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "eventCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "keyEvents": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "totalRevenue": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "purchaseRevenue": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "transactions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "ecommercePurchases": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "userEngagementDuration": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "sessionDurationWeighted": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "engagementRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "bounceRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "averageSessionDuration": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "sessionsPerUser": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "screenPageViewsPerSession": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "eventCountPerUser": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "conversionRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "revenuePerSession": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "sessions", "totalUsers", "activeUsers", "newUsers", "engagedSessions", "screenPageViews", "eventCount", "keyEvents", "totalRevenue", "purchaseRevenue", "transactions", "ecommercePurchases", "userEngagementDuration", "sessionDurationWeighted", "engagementRate", "bounceRate", "averageSessionDuration", "sessionsPerUser", "screenPageViewsPerSession", "eventCountPerUser", "conversionRate", "revenuePerSession" ], "additionalProperties": false }, "previous": { "anyOf": [ { "type": "object", "properties": { "sessions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "totalUsers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "activeUsers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "newUsers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "engagedSessions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "screenPageViews": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "eventCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "keyEvents": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "totalRevenue": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "purchaseRevenue": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "transactions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "ecommercePurchases": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "userEngagementDuration": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "sessionDurationWeighted": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "engagementRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "bounceRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "averageSessionDuration": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "sessionsPerUser": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "screenPageViewsPerSession": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "eventCountPerUser": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "conversionRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "revenuePerSession": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "sessions", "totalUsers", "activeUsers", "newUsers", "engagedSessions", "screenPageViews", "eventCount", "keyEvents", "totalRevenue", "purchaseRevenue", "transactions", "ecommercePurchases", "userEngagementDuration", "sessionDurationWeighted", "engagementRate", "bounceRate", "averageSessionDuration", "sessionsPerUser", "screenPageViewsPerSession", "eventCountPerUser", "conversionRate", "revenuePerSession" ], "additionalProperties": false }, { "type": "null" } ] }, "series": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "sessions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "totalUsers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "newUsers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "engagedSessions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "keyEvents": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "totalRevenue": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "date", "sessions", "totalUsers", "newUsers", "engagedSessions", "keyEvents", "totalRevenue" ], "additionalProperties": false } }, "previousSeries": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "sessions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "totalUsers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "newUsers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "engagedSessions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "keyEvents": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "totalRevenue": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "date", "sessions", "totalUsers", "newUsers", "engagedSessions", "keyEvents", "totalRevenue" ], "additionalProperties": false } }, "channels": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "label": { "type": "string" }, "detail": { "type": "string" }, "totals": { "type": "object", "properties": { "sessions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "totalUsers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "activeUsers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "newUsers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "engagedSessions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "screenPageViews": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "eventCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "keyEvents": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "totalRevenue": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "purchaseRevenue": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "transactions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "ecommercePurchases": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "userEngagementDuration": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "sessionDurationWeighted": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "engagementRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "bounceRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "averageSessionDuration": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "sessionsPerUser": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "screenPageViewsPerSession": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "eventCountPerUser": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "conversionRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "revenuePerSession": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "sessions", "totalUsers", "activeUsers", "newUsers", "engagedSessions", "screenPageViews", "eventCount", "keyEvents", "totalRevenue", "purchaseRevenue", "transactions", "ecommercePurchases", "userEngagementDuration", "sessionDurationWeighted", "engagementRate", "bounceRate", "averageSessionDuration", "sessionsPerUser", "screenPageViewsPerSession", "eventCountPerUser", "conversionRate", "revenuePerSession" ], "additionalProperties": false }, "previous": { "anyOf": [ { "type": "object", "properties": { "sessions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "totalUsers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "activeUsers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "newUsers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "engagedSessions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "screenPageViews": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "eventCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "keyEvents": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "totalRevenue": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "purchaseRevenue": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "transactions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "ecommercePurchases": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "userEngagementDuration": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "sessionDurationWeighted": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "engagementRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "bounceRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "averageSessionDuration": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "sessionsPerUser": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "screenPageViewsPerSession": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "eventCountPerUser": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "conversionRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "revenuePerSession": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "sessions", "totalUsers", "activeUsers", "newUsers", "engagedSessions", "screenPageViews", "eventCount", "keyEvents", "totalRevenue", "purchaseRevenue", "transactions", "ecommercePurchases", "userEngagementDuration", "sessionDurationWeighted", "engagementRate", "bounceRate", "averageSessionDuration", "sessionsPerUser", "screenPageViewsPerSession", "eventCountPerUser", "conversionRate", "revenuePerSession" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "key", "label", "totals", "previous" ], "additionalProperties": false } }, "sources": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "label": { "type": "string" }, "detail": { "type": "string" }, "totals": { "type": "object", "properties": { "sessions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "totalUsers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "activeUsers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "newUsers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "engagedSessions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "screenPageViews": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "eventCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "keyEvents": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "totalRevenue": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "purchaseRevenue": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "transactions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "ecommercePurchases": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "userEngagementDuration": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "sessionDurationWeighted": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "engagementRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "bounceRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "averageSessionDuration": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "sessionsPerUser": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "screenPageViewsPerSession": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "eventCountPerUser": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "conversionRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "revenuePerSession": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "sessions", "totalUsers", "activeUsers", "newUsers", "engagedSessions", "screenPageViews", "eventCount", "keyEvents", "totalRevenue", "purchaseRevenue", "transactions", "ecommercePurchases", "userEngagementDuration", "sessionDurationWeighted", "engagementRate", "bounceRate", "averageSessionDuration", "sessionsPerUser", "screenPageViewsPerSession", "eventCountPerUser", "conversionRate", "revenuePerSession" ], "additionalProperties": false }, "previous": { "anyOf": [ { "type": "object", "properties": { "sessions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "totalUsers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "activeUsers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "newUsers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "engagedSessions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "screenPageViews": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "eventCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "keyEvents": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "totalRevenue": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "purchaseRevenue": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "transactions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "ecommercePurchases": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "userEngagementDuration": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "sessionDurationWeighted": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "engagementRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "bounceRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "averageSessionDuration": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "sessionsPerUser": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "screenPageViewsPerSession": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "eventCountPerUser": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "conversionRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "revenuePerSession": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "sessions", "totalUsers", "activeUsers", "newUsers", "engagedSessions", "screenPageViews", "eventCount", "keyEvents", "totalRevenue", "purchaseRevenue", "transactions", "ecommercePurchases", "userEngagementDuration", "sessionDurationWeighted", "engagementRate", "bounceRate", "averageSessionDuration", "sessionsPerUser", "screenPageViewsPerSession", "eventCountPerUser", "conversionRate", "revenuePerSession" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "key", "label", "totals", "previous" ], "additionalProperties": false } }, "landingPages": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "label": { "type": "string" }, "detail": { "type": "string" }, "totals": { "type": "object", "properties": { "sessions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "totalUsers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "activeUsers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "newUsers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "engagedSessions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "screenPageViews": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "eventCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "keyEvents": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "totalRevenue": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "purchaseRevenue": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "transactions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "ecommercePurchases": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "userEngagementDuration": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "sessionDurationWeighted": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "engagementRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "bounceRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "averageSessionDuration": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "sessionsPerUser": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "screenPageViewsPerSession": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "eventCountPerUser": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "conversionRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "revenuePerSession": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "sessions", "totalUsers", "activeUsers", "newUsers", "engagedSessions", "screenPageViews", "eventCount", "keyEvents", "totalRevenue", "purchaseRevenue", "transactions", "ecommercePurchases", "userEngagementDuration", "sessionDurationWeighted", "engagementRate", "bounceRate", "averageSessionDuration", "sessionsPerUser", "screenPageViewsPerSession", "eventCountPerUser", "conversionRate", "revenuePerSession" ], "additionalProperties": false }, "previous": { "anyOf": [ { "type": "object", "properties": { "sessions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "totalUsers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "activeUsers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "newUsers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "engagedSessions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "screenPageViews": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "eventCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "keyEvents": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "totalRevenue": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "purchaseRevenue": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "transactions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "ecommercePurchases": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "userEngagementDuration": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "sessionDurationWeighted": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "engagementRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "bounceRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "averageSessionDuration": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "sessionsPerUser": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "screenPageViewsPerSession": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "eventCountPerUser": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "conversionRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "revenuePerSession": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "sessions", "totalUsers", "activeUsers", "newUsers", "engagedSessions", "screenPageViews", "eventCount", "keyEvents", "totalRevenue", "purchaseRevenue", "transactions", "ecommercePurchases", "userEngagementDuration", "sessionDurationWeighted", "engagementRate", "bounceRate", "averageSessionDuration", "sessionsPerUser", "screenPageViewsPerSession", "eventCountPerUser", "conversionRate", "revenuePerSession" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "key", "label", "totals", "previous" ], "additionalProperties": false } }, "organicLandingPages": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "label": { "type": "string" }, "detail": { "type": "string" }, "totals": { "type": "object", "properties": { "sessions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "totalUsers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "activeUsers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "newUsers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "engagedSessions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "screenPageViews": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "eventCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "keyEvents": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "totalRevenue": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "purchaseRevenue": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "transactions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "ecommercePurchases": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "userEngagementDuration": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "sessionDurationWeighted": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "engagementRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "bounceRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "averageSessionDuration": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "sessionsPerUser": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "screenPageViewsPerSession": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "eventCountPerUser": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "conversionRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "revenuePerSession": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "sessions", "totalUsers", "activeUsers", "newUsers", "engagedSessions", "screenPageViews", "eventCount", "keyEvents", "totalRevenue", "purchaseRevenue", "transactions", "ecommercePurchases", "userEngagementDuration", "sessionDurationWeighted", "engagementRate", "bounceRate", "averageSessionDuration", "sessionsPerUser", "screenPageViewsPerSession", "eventCountPerUser", "conversionRate", "revenuePerSession" ], "additionalProperties": false }, "previous": { "anyOf": [ { "type": "object", "properties": { "sessions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "totalUsers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "activeUsers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "newUsers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "engagedSessions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "screenPageViews": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "eventCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "keyEvents": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "totalRevenue": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "purchaseRevenue": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "transactions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "ecommercePurchases": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "userEngagementDuration": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "sessionDurationWeighted": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "engagementRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "bounceRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "averageSessionDuration": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "sessionsPerUser": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "screenPageViewsPerSession": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "eventCountPerUser": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "conversionRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "revenuePerSession": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "sessions", "totalUsers", "activeUsers", "newUsers", "engagedSessions", "screenPageViews", "eventCount", "keyEvents", "totalRevenue", "purchaseRevenue", "transactions", "ecommercePurchases", "userEngagementDuration", "sessionDurationWeighted", "engagementRate", "bounceRate", "averageSessionDuration", "sessionsPerUser", "screenPageViewsPerSession", "eventCountPerUser", "conversionRate", "revenuePerSession" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "key", "label", "totals", "previous" ], "additionalProperties": false } }, "pages": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "label": { "type": "string" }, "detail": { "type": "string" }, "totals": { "type": "object", "properties": { "sessions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "totalUsers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "activeUsers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "newUsers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "engagedSessions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "screenPageViews": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "eventCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "keyEvents": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "totalRevenue": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "purchaseRevenue": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "transactions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "ecommercePurchases": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "userEngagementDuration": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "sessionDurationWeighted": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "engagementRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "bounceRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "averageSessionDuration": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "sessionsPerUser": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "screenPageViewsPerSession": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "eventCountPerUser": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "conversionRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "revenuePerSession": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "sessions", "totalUsers", "activeUsers", "newUsers", "engagedSessions", "screenPageViews", "eventCount", "keyEvents", "totalRevenue", "purchaseRevenue", "transactions", "ecommercePurchases", "userEngagementDuration", "sessionDurationWeighted", "engagementRate", "bounceRate", "averageSessionDuration", "sessionsPerUser", "screenPageViewsPerSession", "eventCountPerUser", "conversionRate", "revenuePerSession" ], "additionalProperties": false }, "previous": { "anyOf": [ { "type": "object", "properties": { "sessions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "totalUsers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "activeUsers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "newUsers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "engagedSessions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "screenPageViews": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "eventCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "keyEvents": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "totalRevenue": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "purchaseRevenue": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "transactions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "ecommercePurchases": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "userEngagementDuration": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "sessionDurationWeighted": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "engagementRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "bounceRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "averageSessionDuration": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "sessionsPerUser": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "screenPageViewsPerSession": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "eventCountPerUser": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "conversionRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "revenuePerSession": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "sessions", "totalUsers", "activeUsers", "newUsers", "engagedSessions", "screenPageViews", "eventCount", "keyEvents", "totalRevenue", "purchaseRevenue", "transactions", "ecommercePurchases", "userEngagementDuration", "sessionDurationWeighted", "engagementRate", "bounceRate", "averageSessionDuration", "sessionsPerUser", "screenPageViewsPerSession", "eventCountPerUser", "conversionRate", "revenuePerSession" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "key", "label", "totals", "previous" ], "additionalProperties": false } }, "events": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "label": { "type": "string" }, "detail": { "type": "string" }, "totals": { "type": "object", "properties": { "sessions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "totalUsers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "activeUsers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "newUsers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "engagedSessions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "screenPageViews": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "eventCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "keyEvents": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "totalRevenue": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "purchaseRevenue": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "transactions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "ecommercePurchases": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "userEngagementDuration": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "sessionDurationWeighted": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "engagementRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "bounceRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "averageSessionDuration": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "sessionsPerUser": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "screenPageViewsPerSession": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "eventCountPerUser": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "conversionRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "revenuePerSession": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "sessions", "totalUsers", "activeUsers", "newUsers", "engagedSessions", "screenPageViews", "eventCount", "keyEvents", "totalRevenue", "purchaseRevenue", "transactions", "ecommercePurchases", "userEngagementDuration", "sessionDurationWeighted", "engagementRate", "bounceRate", "averageSessionDuration", "sessionsPerUser", "screenPageViewsPerSession", "eventCountPerUser", "conversionRate", "revenuePerSession" ], "additionalProperties": false }, "previous": { "anyOf": [ { "type": "object", "properties": { "sessions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "totalUsers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "activeUsers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "newUsers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "engagedSessions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "screenPageViews": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "eventCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "keyEvents": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "totalRevenue": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "purchaseRevenue": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "transactions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "ecommercePurchases": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "userEngagementDuration": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "sessionDurationWeighted": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "engagementRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "bounceRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "averageSessionDuration": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "sessionsPerUser": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "screenPageViewsPerSession": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "eventCountPerUser": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "conversionRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "revenuePerSession": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "sessions", "totalUsers", "activeUsers", "newUsers", "engagedSessions", "screenPageViews", "eventCount", "keyEvents", "totalRevenue", "purchaseRevenue", "transactions", "ecommercePurchases", "userEngagementDuration", "sessionDurationWeighted", "engagementRate", "bounceRate", "averageSessionDuration", "sessionsPerUser", "screenPageViewsPerSession", "eventCountPerUser", "conversionRate", "revenuePerSession" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "key", "label", "totals", "previous" ], "additionalProperties": false } }, "devices": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "label": { "type": "string" }, "detail": { "type": "string" }, "totals": { "type": "object", "properties": { "sessions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "totalUsers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "activeUsers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "newUsers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "engagedSessions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "screenPageViews": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "eventCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "keyEvents": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "totalRevenue": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "purchaseRevenue": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "transactions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "ecommercePurchases": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "userEngagementDuration": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "sessionDurationWeighted": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "engagementRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "bounceRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "averageSessionDuration": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "sessionsPerUser": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "screenPageViewsPerSession": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "eventCountPerUser": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "conversionRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "revenuePerSession": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "sessions", "totalUsers", "activeUsers", "newUsers", "engagedSessions", "screenPageViews", "eventCount", "keyEvents", "totalRevenue", "purchaseRevenue", "transactions", "ecommercePurchases", "userEngagementDuration", "sessionDurationWeighted", "engagementRate", "bounceRate", "averageSessionDuration", "sessionsPerUser", "screenPageViewsPerSession", "eventCountPerUser", "conversionRate", "revenuePerSession" ], "additionalProperties": false }, "previous": { "anyOf": [ { "type": "object", "properties": { "sessions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "totalUsers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "activeUsers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "newUsers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "engagedSessions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "screenPageViews": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "eventCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "keyEvents": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "totalRevenue": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "purchaseRevenue": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "transactions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "ecommercePurchases": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "userEngagementDuration": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "sessionDurationWeighted": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "engagementRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "bounceRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "averageSessionDuration": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "sessionsPerUser": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "screenPageViewsPerSession": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "eventCountPerUser": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "conversionRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "revenuePerSession": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "sessions", "totalUsers", "activeUsers", "newUsers", "engagedSessions", "screenPageViews", "eventCount", "keyEvents", "totalRevenue", "purchaseRevenue", "transactions", "ecommercePurchases", "userEngagementDuration", "sessionDurationWeighted", "engagementRate", "bounceRate", "averageSessionDuration", "sessionsPerUser", "screenPageViewsPerSession", "eventCountPerUser", "conversionRate", "revenuePerSession" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "key", "label", "totals", "previous" ], "additionalProperties": false } }, "countries": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "label": { "type": "string" }, "detail": { "type": "string" }, "totals": { "type": "object", "properties": { "sessions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "totalUsers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "activeUsers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "newUsers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "engagedSessions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "screenPageViews": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "eventCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "keyEvents": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "totalRevenue": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "purchaseRevenue": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "transactions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "ecommercePurchases": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "userEngagementDuration": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "sessionDurationWeighted": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "engagementRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "bounceRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "averageSessionDuration": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "sessionsPerUser": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "screenPageViewsPerSession": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "eventCountPerUser": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "conversionRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "revenuePerSession": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "sessions", "totalUsers", "activeUsers", "newUsers", "engagedSessions", "screenPageViews", "eventCount", "keyEvents", "totalRevenue", "purchaseRevenue", "transactions", "ecommercePurchases", "userEngagementDuration", "sessionDurationWeighted", "engagementRate", "bounceRate", "averageSessionDuration", "sessionsPerUser", "screenPageViewsPerSession", "eventCountPerUser", "conversionRate", "revenuePerSession" ], "additionalProperties": false }, "previous": { "anyOf": [ { "type": "object", "properties": { "sessions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "totalUsers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "activeUsers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "newUsers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "engagedSessions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "screenPageViews": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "eventCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "keyEvents": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "totalRevenue": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "purchaseRevenue": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "transactions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "ecommercePurchases": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "userEngagementDuration": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "sessionDurationWeighted": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "engagementRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "bounceRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "averageSessionDuration": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "sessionsPerUser": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "screenPageViewsPerSession": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "eventCountPerUser": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "conversionRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "revenuePerSession": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "sessions", "totalUsers", "activeUsers", "newUsers", "engagedSessions", "screenPageViews", "eventCount", "keyEvents", "totalRevenue", "purchaseRevenue", "transactions", "ecommercePurchases", "userEngagementDuration", "sessionDurationWeighted", "engagementRate", "bounceRate", "averageSessionDuration", "sessionsPerUser", "screenPageViewsPerSession", "eventCountPerUser", "conversionRate", "revenuePerSession" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "key", "label", "totals", "previous" ], "additionalProperties": false } }, "newReturning": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "label": { "type": "string" }, "detail": { "type": "string" }, "totals": { "type": "object", "properties": { "sessions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "totalUsers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "activeUsers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "newUsers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "engagedSessions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "screenPageViews": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "eventCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "keyEvents": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "totalRevenue": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "purchaseRevenue": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "transactions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "ecommercePurchases": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "userEngagementDuration": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "sessionDurationWeighted": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "engagementRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "bounceRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "averageSessionDuration": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "sessionsPerUser": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "screenPageViewsPerSession": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "eventCountPerUser": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "conversionRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "revenuePerSession": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "sessions", "totalUsers", "activeUsers", "newUsers", "engagedSessions", "screenPageViews", "eventCount", "keyEvents", "totalRevenue", "purchaseRevenue", "transactions", "ecommercePurchases", "userEngagementDuration", "sessionDurationWeighted", "engagementRate", "bounceRate", "averageSessionDuration", "sessionsPerUser", "screenPageViewsPerSession", "eventCountPerUser", "conversionRate", "revenuePerSession" ], "additionalProperties": false }, "previous": { "anyOf": [ { "type": "object", "properties": { "sessions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "totalUsers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "activeUsers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "newUsers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "engagedSessions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "screenPageViews": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "eventCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "keyEvents": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "totalRevenue": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "purchaseRevenue": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "transactions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "ecommercePurchases": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "userEngagementDuration": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "sessionDurationWeighted": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "engagementRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "bounceRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "averageSessionDuration": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "sessionsPerUser": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "screenPageViewsPerSession": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "eventCountPerUser": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "conversionRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "revenuePerSession": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "sessions", "totalUsers", "activeUsers", "newUsers", "engagedSessions", "screenPageViews", "eventCount", "keyEvents", "totalRevenue", "purchaseRevenue", "transactions", "ecommercePurchases", "userEngagementDuration", "sessionDurationWeighted", "engagementRate", "bounceRate", "averageSessionDuration", "sessionsPerUser", "screenPageViewsPerSession", "eventCountPerUser", "conversionRate", "revenuePerSession" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "key", "label", "totals", "previous" ], "additionalProperties": false } }, "partial": { "type": "boolean" } }, "required": [ "properties", "currency", "totals", "previous", "series", "previousSeries", "channels", "sources", "landingPages", "organicLandingPages", "pages", "events", "devices", "countries", "newReturning", "partial" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "from", "to", "compare", "analytics" ], "additionalProperties": false }, "meta": { "type": "object", "properties": { "from": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "to": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "timezone": { "type": "string", "const": "Asia/Kolkata" }, "syncedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "truncated": { "type": "boolean" }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "timezone", "syncedAt" ], "additionalProperties": false } } } } } }, "400": { "description": "Invalid query", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Key lacks the required scope", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found in this organisation", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limited (60 requests per minute per key)", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/website/search": { "get": { "summary": "Search Console: clicks, impressions, CTR, average position, daily series and the query, page, country, device and appearance tables", "description": "position is a rank (lower is better) weighted by impressions. Query rows do not sum to the site totals — Google withholds rare queries. Days are Pacific.", "security": [ { "apiKey": [] } ], "x-scope": "web:read", "parameters": [ { "name": "client", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "from", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, { "name": "to", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, { "name": "compare", "in": "query", "required": false, "schema": { "default": "previous", "type": "string", "enum": [ "previous", "prevMonth", "prevYear", "none" ] } }, { "name": "searchType", "in": "query", "required": false, "schema": { "default": "web", "type": "string", "enum": [ "web", "image", "video", "news", "discover", "googleNews" ] } }, { "name": "limit", "in": "query", "required": false, "schema": { "default": 25, "type": "integer", "minimum": 1, "maximum": 100 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "meta" ], "properties": { "data": { "type": "object", "properties": { "from": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "to": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "compare": { "anyOf": [ { "type": "object", "properties": { "from": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "to": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, "required": [ "from", "to" ], "additionalProperties": false }, { "type": "null" } ] }, "search": { "anyOf": [ { "type": "object", "properties": { "sites": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "siteUrl": { "type": "string" }, "lastSyncedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "firstIncompleteDate": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "siteUrl", "lastSyncedAt", "firstIncompleteDate" ], "additionalProperties": false } }, "searchType": { "type": "string" }, "totals": { "type": "object", "properties": { "clicks": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "impressions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "positionWeighted": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "ctr": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "position": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "clicks", "impressions", "positionWeighted", "ctr", "position" ], "additionalProperties": false }, "previous": { "anyOf": [ { "type": "object", "properties": { "clicks": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "impressions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "positionWeighted": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "ctr": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "position": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "clicks", "impressions", "positionWeighted", "ctr", "position" ], "additionalProperties": false }, { "type": "null" } ] }, "series": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "clicks": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "impressions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "ctr": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "position": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "date", "clicks", "impressions", "ctr", "position" ], "additionalProperties": false } }, "previousSeries": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "clicks": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "impressions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "ctr": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "position": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "date", "clicks", "impressions", "ctr", "position" ], "additionalProperties": false } }, "queries": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "label": { "type": "string" }, "totals": { "type": "object", "properties": { "clicks": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "impressions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "positionWeighted": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "ctr": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "position": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "clicks", "impressions", "positionWeighted", "ctr", "position" ], "additionalProperties": false }, "previous": { "anyOf": [ { "type": "object", "properties": { "clicks": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "impressions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "positionWeighted": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "ctr": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "position": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "clicks", "impressions", "positionWeighted", "ctr", "position" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "key", "label", "totals", "previous" ], "additionalProperties": false } }, "pages": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "label": { "type": "string" }, "totals": { "type": "object", "properties": { "clicks": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "impressions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "positionWeighted": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "ctr": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "position": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "clicks", "impressions", "positionWeighted", "ctr", "position" ], "additionalProperties": false }, "previous": { "anyOf": [ { "type": "object", "properties": { "clicks": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "impressions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "positionWeighted": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "ctr": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "position": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "clicks", "impressions", "positionWeighted", "ctr", "position" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "key", "label", "totals", "previous" ], "additionalProperties": false } }, "countries": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "label": { "type": "string" }, "totals": { "type": "object", "properties": { "clicks": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "impressions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "positionWeighted": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "ctr": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "position": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "clicks", "impressions", "positionWeighted", "ctr", "position" ], "additionalProperties": false }, "previous": { "anyOf": [ { "type": "object", "properties": { "clicks": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "impressions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "positionWeighted": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "ctr": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "position": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "clicks", "impressions", "positionWeighted", "ctr", "position" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "key", "label", "totals", "previous" ], "additionalProperties": false } }, "devices": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "label": { "type": "string" }, "totals": { "type": "object", "properties": { "clicks": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "impressions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "positionWeighted": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "ctr": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "position": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "clicks", "impressions", "positionWeighted", "ctr", "position" ], "additionalProperties": false }, "previous": { "anyOf": [ { "type": "object", "properties": { "clicks": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "impressions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "positionWeighted": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "ctr": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "position": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "clicks", "impressions", "positionWeighted", "ctr", "position" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "key", "label", "totals", "previous" ], "additionalProperties": false } }, "appearances": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "label": { "type": "string" }, "totals": { "type": "object", "properties": { "clicks": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "impressions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "positionWeighted": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "ctr": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "position": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "clicks", "impressions", "positionWeighted", "ctr", "position" ], "additionalProperties": false }, "previous": { "anyOf": [ { "type": "object", "properties": { "clicks": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "impressions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "positionWeighted": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "ctr": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "position": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "clicks", "impressions", "positionWeighted", "ctr", "position" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "key", "label", "totals", "previous" ], "additionalProperties": false } } }, "required": [ "sites", "searchType", "totals", "previous", "series", "previousSeries", "queries", "pages", "countries", "devices", "appearances" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "from", "to", "compare", "search" ], "additionalProperties": false }, "meta": { "type": "object", "properties": { "from": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "to": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "timezone": { "type": "string", "const": "Asia/Kolkata" }, "syncedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "truncated": { "type": "boolean" }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "timezone", "syncedAt" ], "additionalProperties": false } } } } } }, "400": { "description": "Invalid query", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Key lacks the required scope", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found in this organisation", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limited (60 requests per minute per key)", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/store/overview": { "get": { "summary": "Shopify: sales ladder, orders, customers, AOV, daily series and the product, channel, referrer, country and discount tables", "description": "Shopify definitions: gross sales includes cancelled and unpaid orders and excludes tax and shipping; returns are dated on the refund. There are no sessions or conversion rate in the Admin API. Days follow the shop’s timezone.", "security": [ { "apiKey": [] } ], "x-scope": "store:read", "parameters": [ { "name": "client", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "from", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, { "name": "to", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, { "name": "compare", "in": "query", "required": false, "schema": { "default": "previous", "type": "string", "enum": [ "previous", "prevMonth", "prevYear", "none" ] } }, { "name": "limit", "in": "query", "required": false, "schema": { "default": 25, "type": "integer", "minimum": 1, "maximum": 100 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "meta" ], "properties": { "data": { "type": "object", "properties": { "from": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "to": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "compare": { "anyOf": [ { "type": "object", "properties": { "from": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "to": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, "required": [ "from", "to" ], "additionalProperties": false }, { "type": "null" } ] }, "store": { "anyOf": [ { "type": "object", "properties": { "stores": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "shopDomain": { "type": "string" }, "shopName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "lastSyncedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "hasAllOrdersScope": { "type": "boolean" } }, "required": [ "id", "shopDomain", "shopName", "timezone", "lastSyncedAt", "hasAllOrdersScope" ], "additionalProperties": false } }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "totals": { "type": "object", "properties": { "grossSales": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "discounts": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "returns": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "netSales": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "shipping": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "taxes": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "duties": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "tips": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "totalSales": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "orders": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "cancelledOrders": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "refundedOrders": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "unitsSold": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "customers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "newCustomers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "returningCustomers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "averageOrderValue": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "averageUnitsPerOrder": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "returnRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "discountRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "newCustomerRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "revenuePerCustomer": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "grossSales", "discounts", "returns", "netSales", "shipping", "taxes", "duties", "tips", "totalSales", "orders", "cancelledOrders", "refundedOrders", "unitsSold", "customers", "newCustomers", "returningCustomers", "averageOrderValue", "averageUnitsPerOrder", "returnRate", "discountRate", "newCustomerRate", "revenuePerCustomer" ], "additionalProperties": false }, "previous": { "anyOf": [ { "type": "object", "properties": { "grossSales": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "discounts": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "returns": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "netSales": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "shipping": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "taxes": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "duties": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "tips": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "totalSales": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "orders": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "cancelledOrders": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "refundedOrders": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "unitsSold": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "customers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "newCustomers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "returningCustomers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "averageOrderValue": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "averageUnitsPerOrder": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "returnRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "discountRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "newCustomerRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "revenuePerCustomer": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "grossSales", "discounts", "returns", "netSales", "shipping", "taxes", "duties", "tips", "totalSales", "orders", "cancelledOrders", "refundedOrders", "unitsSold", "customers", "newCustomers", "returningCustomers", "averageOrderValue", "averageUnitsPerOrder", "returnRate", "discountRate", "newCustomerRate", "revenuePerCustomer" ], "additionalProperties": false }, { "type": "null" } ] }, "series": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "netSales": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "grossSales": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "orders": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "unitsSold": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "returns": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "newCustomers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "date", "netSales", "grossSales", "orders", "unitsSold", "returns", "newCustomers" ], "additionalProperties": false } }, "previousSeries": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "netSales": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "grossSales": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "orders": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "unitsSold": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "returns": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "newCustomers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "date", "netSales", "grossSales", "orders", "unitsSold", "returns", "newCustomers" ], "additionalProperties": false } }, "products": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "label": { "type": "string" }, "detail": { "type": "string" }, "totals": { "type": "object", "properties": { "grossSales": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "discounts": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "returns": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "netSales": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "shipping": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "taxes": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "duties": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "tips": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "totalSales": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "orders": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "cancelledOrders": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "refundedOrders": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "unitsSold": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "customers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "newCustomers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "returningCustomers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "averageOrderValue": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "averageUnitsPerOrder": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "returnRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "discountRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "newCustomerRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "revenuePerCustomer": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "grossSales", "discounts", "returns", "netSales", "shipping", "taxes", "duties", "tips", "totalSales", "orders", "cancelledOrders", "refundedOrders", "unitsSold", "customers", "newCustomers", "returningCustomers", "averageOrderValue", "averageUnitsPerOrder", "returnRate", "discountRate", "newCustomerRate", "revenuePerCustomer" ], "additionalProperties": false }, "previous": { "anyOf": [ { "type": "object", "properties": { "grossSales": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "discounts": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "returns": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "netSales": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "shipping": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "taxes": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "duties": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "tips": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "totalSales": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "orders": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "cancelledOrders": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "refundedOrders": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "unitsSold": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "customers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "newCustomers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "returningCustomers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "averageOrderValue": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "averageUnitsPerOrder": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "returnRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "discountRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "newCustomerRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "revenuePerCustomer": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "grossSales", "discounts", "returns", "netSales", "shipping", "taxes", "duties", "tips", "totalSales", "orders", "cancelledOrders", "refundedOrders", "unitsSold", "customers", "newCustomers", "returningCustomers", "averageOrderValue", "averageUnitsPerOrder", "returnRate", "discountRate", "newCustomerRate", "revenuePerCustomer" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "key", "label", "totals", "previous" ], "additionalProperties": false } }, "channels": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "label": { "type": "string" }, "detail": { "type": "string" }, "totals": { "type": "object", "properties": { "grossSales": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "discounts": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "returns": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "netSales": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "shipping": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "taxes": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "duties": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "tips": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "totalSales": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "orders": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "cancelledOrders": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "refundedOrders": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "unitsSold": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "customers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "newCustomers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "returningCustomers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "averageOrderValue": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "averageUnitsPerOrder": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "returnRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "discountRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "newCustomerRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "revenuePerCustomer": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "grossSales", "discounts", "returns", "netSales", "shipping", "taxes", "duties", "tips", "totalSales", "orders", "cancelledOrders", "refundedOrders", "unitsSold", "customers", "newCustomers", "returningCustomers", "averageOrderValue", "averageUnitsPerOrder", "returnRate", "discountRate", "newCustomerRate", "revenuePerCustomer" ], "additionalProperties": false }, "previous": { "anyOf": [ { "type": "object", "properties": { "grossSales": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "discounts": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "returns": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "netSales": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "shipping": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "taxes": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "duties": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "tips": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "totalSales": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "orders": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "cancelledOrders": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "refundedOrders": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "unitsSold": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "customers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "newCustomers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "returningCustomers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "averageOrderValue": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "averageUnitsPerOrder": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "returnRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "discountRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "newCustomerRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "revenuePerCustomer": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "grossSales", "discounts", "returns", "netSales", "shipping", "taxes", "duties", "tips", "totalSales", "orders", "cancelledOrders", "refundedOrders", "unitsSold", "customers", "newCustomers", "returningCustomers", "averageOrderValue", "averageUnitsPerOrder", "returnRate", "discountRate", "newCustomerRate", "revenuePerCustomer" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "key", "label", "totals", "previous" ], "additionalProperties": false } }, "referrers": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "label": { "type": "string" }, "detail": { "type": "string" }, "totals": { "type": "object", "properties": { "grossSales": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "discounts": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "returns": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "netSales": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "shipping": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "taxes": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "duties": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "tips": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "totalSales": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "orders": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "cancelledOrders": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "refundedOrders": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "unitsSold": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "customers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "newCustomers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "returningCustomers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "averageOrderValue": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "averageUnitsPerOrder": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "returnRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "discountRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "newCustomerRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "revenuePerCustomer": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "grossSales", "discounts", "returns", "netSales", "shipping", "taxes", "duties", "tips", "totalSales", "orders", "cancelledOrders", "refundedOrders", "unitsSold", "customers", "newCustomers", "returningCustomers", "averageOrderValue", "averageUnitsPerOrder", "returnRate", "discountRate", "newCustomerRate", "revenuePerCustomer" ], "additionalProperties": false }, "previous": { "anyOf": [ { "type": "object", "properties": { "grossSales": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "discounts": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "returns": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "netSales": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "shipping": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "taxes": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "duties": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "tips": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "totalSales": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "orders": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "cancelledOrders": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "refundedOrders": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "unitsSold": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "customers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "newCustomers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "returningCustomers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "averageOrderValue": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "averageUnitsPerOrder": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "returnRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "discountRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "newCustomerRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "revenuePerCustomer": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "grossSales", "discounts", "returns", "netSales", "shipping", "taxes", "duties", "tips", "totalSales", "orders", "cancelledOrders", "refundedOrders", "unitsSold", "customers", "newCustomers", "returningCustomers", "averageOrderValue", "averageUnitsPerOrder", "returnRate", "discountRate", "newCustomerRate", "revenuePerCustomer" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "key", "label", "totals", "previous" ], "additionalProperties": false } }, "countries": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "label": { "type": "string" }, "detail": { "type": "string" }, "totals": { "type": "object", "properties": { "grossSales": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "discounts": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "returns": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "netSales": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "shipping": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "taxes": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "duties": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "tips": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "totalSales": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "orders": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "cancelledOrders": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "refundedOrders": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "unitsSold": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "customers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "newCustomers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "returningCustomers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "averageOrderValue": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "averageUnitsPerOrder": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "returnRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "discountRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "newCustomerRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "revenuePerCustomer": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "grossSales", "discounts", "returns", "netSales", "shipping", "taxes", "duties", "tips", "totalSales", "orders", "cancelledOrders", "refundedOrders", "unitsSold", "customers", "newCustomers", "returningCustomers", "averageOrderValue", "averageUnitsPerOrder", "returnRate", "discountRate", "newCustomerRate", "revenuePerCustomer" ], "additionalProperties": false }, "previous": { "anyOf": [ { "type": "object", "properties": { "grossSales": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "discounts": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "returns": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "netSales": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "shipping": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "taxes": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "duties": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "tips": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "totalSales": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "orders": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "cancelledOrders": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "refundedOrders": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "unitsSold": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "customers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "newCustomers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "returningCustomers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "averageOrderValue": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "averageUnitsPerOrder": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "returnRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "discountRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "newCustomerRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "revenuePerCustomer": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "grossSales", "discounts", "returns", "netSales", "shipping", "taxes", "duties", "tips", "totalSales", "orders", "cancelledOrders", "refundedOrders", "unitsSold", "customers", "newCustomers", "returningCustomers", "averageOrderValue", "averageUnitsPerOrder", "returnRate", "discountRate", "newCustomerRate", "revenuePerCustomer" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "key", "label", "totals", "previous" ], "additionalProperties": false } }, "discounts": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "label": { "type": "string" }, "detail": { "type": "string" }, "totals": { "type": "object", "properties": { "grossSales": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "discounts": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "returns": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "netSales": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "shipping": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "taxes": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "duties": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "tips": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "totalSales": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "orders": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "cancelledOrders": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "refundedOrders": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "unitsSold": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "customers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "newCustomers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "returningCustomers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "averageOrderValue": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "averageUnitsPerOrder": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "returnRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "discountRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "newCustomerRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "revenuePerCustomer": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "grossSales", "discounts", "returns", "netSales", "shipping", "taxes", "duties", "tips", "totalSales", "orders", "cancelledOrders", "refundedOrders", "unitsSold", "customers", "newCustomers", "returningCustomers", "averageOrderValue", "averageUnitsPerOrder", "returnRate", "discountRate", "newCustomerRate", "revenuePerCustomer" ], "additionalProperties": false }, "previous": { "anyOf": [ { "type": "object", "properties": { "grossSales": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "discounts": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "returns": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "netSales": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "shipping": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "taxes": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "duties": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "tips": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "totalSales": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "orders": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "cancelledOrders": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "refundedOrders": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "unitsSold": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "customers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "newCustomers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "returningCustomers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "averageOrderValue": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "averageUnitsPerOrder": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "returnRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "discountRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "newCustomerRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "revenuePerCustomer": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "grossSales", "discounts", "returns", "netSales", "shipping", "taxes", "duties", "tips", "totalSales", "orders", "cancelledOrders", "refundedOrders", "unitsSold", "customers", "newCustomers", "returningCustomers", "averageOrderValue", "averageUnitsPerOrder", "returnRate", "discountRate", "newCustomerRate", "revenuePerCustomer" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "key", "label", "totals", "previous" ], "additionalProperties": false } } }, "required": [ "stores", "currency", "totals", "previous", "series", "previousSeries", "products", "channels", "referrers", "countries", "discounts" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "from", "to", "compare", "store" ], "additionalProperties": false }, "meta": { "type": "object", "properties": { "from": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "to": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "timezone": { "type": "string", "const": "Asia/Kolkata" }, "syncedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "truncated": { "type": "boolean" }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "timezone", "syncedAt" ], "additionalProperties": false } } } } } }, "400": { "description": "Invalid query", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Key lacks the required scope", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found in this organisation", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limited (60 requests per minute per key)", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/social/thumbnail": { "get": { "summary": "Stored thumbnail bytes for one post", "security": [ { "apiKey": [] } ], "x-scope": "social:read", "parameters": [ { "name": "post", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "responses": { "200": { "description": "Image bytes", "content": { "image/*": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "Invalid query", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Key lacks the required scope", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found in this organisation", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limited (60 requests per minute per key)", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } } } }