addedInput schema / properties / account
Added value: +{
+ "additionalProperties": false,
+ "description": "One connected account to read. Omit it for every connected analytics account; each comes back on its own, never combined.",
+ "properties": {
+ "accountId": {
+ "description": "The account's id, as a result's account.accountId names it.",
+ "maxLength": 200,
+ "minLength": 1,
+ "type": "string"
+ },
+ "platform": {
+ "description": "The account's platform, as a result's account.platform names it.",
+ "enum": [
+ "instagram",
+ "facebook",
+ "tiktok",
+ "meta_ads",
+ "linkedin",
+ "linkedin_ads",
+ "tiktok_ads",
+ "google_ads",
+ "snapchat_ads",
+ "shopify"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "platform",
+ "accountId"
+ ],
+ "type": "object"
+}
addedOutput schema / properties / accounts
Added value: +{
+ "description": "One entry per connected analytics account, never combined.",
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "account": {
+ "additionalProperties": false,
+ "description": "The connected account every number beside it belongs to.",
+ "properties": {
+ "accountId": {
+ "type": "string"
+ },
+ "accountName": {
+ "type": "string"
+ },
+ "platform": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "platform",
+ "accountId",
+ "accountName"
+ ],
+ "type": "object"
+ },
+ "audience": {
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "dimension": {
+ "type": "string"
+ },
+ "segments": {
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "followers": {
+ "type": [
+ "number",
+ "null"
+ ]
+ },
+ "followersPct": {
+ "type": [
+ "number",
+ "null"
+ ]
+ },
+ "paidImpressions": {
+ "type": [
+ "number",
+ "null"
+ ]
+ },
+ "reach": {
+ "type": [
+ "number",
+ "null"
+ ]
+ },
+ "roas": {
+ "type": [
+ "number",
+ "null"
+ ]
+ },
+ "segment": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "segment",
+ "followers",
+ "followersPct",
+ "reach",
+ "paidImpressions",
+ "roas"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ }
+ },
+ "required": [
+ "dimension",
+ "segments"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "currency": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "hasData": {
+ "type": "boolean"
+ },
+ "kpiTotals": {
+ "description": "Only the metrics the platform reports for the account; LinkedIn follower gain is two metrics, organicFollowerGain and paidFollowerGain. Meta counts ads inside organicReach and organicImpressions; organicReachAds and organicImpressionsAds are the part of each that came from ads.",
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "deltaPct": {
+ "type": [
+ "number",
+ "null"
+ ]
+ },
+ "metric": {
+ "type": "string"
+ },
+ "value": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "metric",
+ "value",
+ "deltaPct"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "kpiTrends": {
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "changePct": {
+ "type": [
+ "number",
+ "null"
+ ]
+ },
+ "first": {
+ "type": "number"
+ },
+ "firstDay": {
+ "type": "string"
+ },
+ "last": {
+ "type": "number"
+ },
+ "lastDay": {
+ "type": "string"
+ },
+ "metric": {
+ "type": "string"
+ },
+ "peak": {
+ "type": "number"
+ },
+ "peakDay": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "metric",
+ "firstDay",
+ "lastDay",
+ "first",
+ "last",
+ "peakDay",
+ "peak",
+ "changePct"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "organicBaselines": {
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "current": {
+ "type": [
+ "number",
+ "null"
+ ]
+ },
+ "median": {
+ "type": [
+ "number",
+ "null"
+ ]
+ },
+ "metric": {
+ "type": "string"
+ },
+ "p25": {
+ "type": [
+ "number",
+ "null"
+ ]
+ },
+ "p75": {
+ "type": [
+ "number",
+ "null"
+ ]
+ },
+ "sampleSize": {
+ "type": [
+ "number",
+ "null"
+ ]
+ }
+ },
+ "required": [
+ "metric",
+ "current",
+ "median",
+ "p25",
+ "p75",
+ "sampleSize"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "topPublications": {
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "engagementRate": {
+ "type": [
+ "number",
+ "null"
+ ]
+ },
+ "impressions": {
+ "type": [
+ "number",
+ "null"
+ ]
+ },
+ "performanceScore": {
+ "type": [
+ "number",
+ "null"
+ ]
+ },
+ "platform": {
+ "type": "string"
+ },
+ "publicationId": {
+ "type": "string"
+ },
+ "rank": {
+ "type": [
+ "number",
+ "null"
+ ]
+ },
+ "reach": {
+ "type": [
+ "number",
+ "null"
+ ]
+ },
+ "roas": {
+ "type": [
+ "number",
+ "null"
+ ]
+ },
+ "spend": {
+ "type": [
+ "number",
+ "null"
+ ]
+ }
+ },
+ "required": [
+ "publicationId",
+ "platform",
+ "performanceScore",
+ "rank",
+ "reach",
+ "impressions",
+ "engagementRate",
+ "spend",
+ "roas"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ }
+ },
+ "required": [
+ "account",
+ "currency",
+ "hasData",
+ "kpiTotals",
+ "kpiTrends",
+ "topPublications",
+ "organicBaselines",
+ "audience"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+}
removedOutput schema / properties / audience
Removed value: -{
- "items": {
- "additionalProperties": false,
- "properties": {
- "dimension": {
- "type": "string"
- },
- "segments": {
- "items": {
- "additionalProperties": false,
- "properties": {
- "followers": {
- "type": [
- "number",
- "null"
- ]
- },
- "followersPct": {
- "type": [
- "number",
- "null"
- ]
- },
- "paidImpressions": {
- "type": [
- "number",
- "null"
- ]
- },
- "reach": {
- "type": [
- "number",
- "null"
- ]
- },
- "roas": {
- "type": [
- "number",
- "null"
- ]
- },
- "segment": {
- "type": "string"
- }
- },
- "required": [
- "segment",
- "followers",
- "followersPct",
- "reach",
- "paidImpressions",
- "roas"
- ],
- "type": "object"
- },
- "type": "array"
- }
- },
- "required": [
- "dimension",
- "segments"
- ],
- "type": "object"
- },
- "type": "array"
-}
removedOutput schema / properties / channels
Removed value: -{
- "items": {
- "additionalProperties": false,
- "properties": {
- "channel": {
- "type": "string"
- },
- "ctr": {
- "type": [
- "number",
- "null"
- ]
- },
- "engagementRate": {
- "type": [
- "number",
- "null"
- ]
- },
- "followerCount": {
- "type": [
- "number",
- "null"
- ]
- },
- "impressions": {
- "type": [
- "number",
- "null"
- ]
- },
- "platform": {
- "type": "string"
- },
- "reach": {
- "type": [
- "number",
- "null"
- ]
- },
- "reachDeltaPct": {
- "type": [
- "number",
- "null"
- ]
- },
- "roas": {
- "type": [
- "number",
- "null"
- ]
- },
- "spend": {
- "type": [
- "number",
- "null"
- ]
- },
- "spendDeltaPct": {
- "type": [
- "number",
- "null"
- ]
- }
- },
- "required": [
- "platform",
- "channel",
- "reach",
- "impressions",
- "engagementRate",
- "followerCount",
- "spend",
- "roas",
- "ctr",
- "reachDeltaPct",
- "spendDeltaPct"
- ],
- "type": "object"
- },
- "type": "array"
-}
removedOutput schema / properties / currency
Removed value: -{
- "type": [
- "string",
- "null"
- ]
-}
removedOutput schema / properties / hasData
Removed value: -{
- "type": "boolean"
-}
removedOutput schema / properties / kpiTotals
Removed value: -{
- "items": {
- "additionalProperties": false,
- "properties": {
- "deltaPct": {
- "type": [
- "number",
- "null"
- ]
- },
- "metric": {
- "type": "string"
- },
- "value": {
- "type": "number"
- }
- },
- "required": [
- "metric",
- "value",
- "deltaPct"
- ],
- "type": "object"
- },
- "type": "array"
-}
removedOutput schema / properties / kpiTrends
Removed value: -{
- "items": {
- "additionalProperties": false,
- "properties": {
- "changePct": {
- "type": [
- "number",
- "null"
- ]
- },
- "first": {
- "type": "number"
- },
- "firstDay": {
- "type": "string"
- },
- "last": {
- "type": "number"
- },
- "lastDay": {
- "type": "string"
- },
- "metric": {
- "type": "string"
- },
- "peak": {
- "type": "number"
- },
- "peakDay": {
- "type": "string"
- }
- },
- "required": [
- "metric",
- "firstDay",
- "lastDay",
- "first",
- "last",
- "peakDay",
- "peak",
- "changePct"
- ],
- "type": "object"
- },
- "type": "array"
-}
removedOutput schema / properties / organicBaselines
Removed value: -{
- "items": {
- "additionalProperties": false,
- "properties": {
- "current": {
- "type": [
- "number",
- "null"
- ]
- },
- "median": {
- "type": [
- "number",
- "null"
- ]
- },
- "metric": {
- "type": "string"
- },
- "p25": {
- "type": [
- "number",
- "null"
- ]
- },
- "p75": {
- "type": [
- "number",
- "null"
- ]
- },
- "sampleSize": {
- "type": [
- "number",
- "null"
- ]
- }
- },
- "required": [
- "metric",
- "current",
- "median",
- "p25",
- "p75",
- "sampleSize"
- ],
- "type": "object"
- },
- "type": "array"
-}
removedOutput schema / properties / reachByChannel
Removed value: -{
- "items": {
- "additionalProperties": false,
- "properties": {
- "channel": {
- "type": "string"
- },
- "platform": {
- "type": "string"
- },
- "reach": {
- "type": "number"
- }
- },
- "required": [
- "platform",
- "channel",
- "reach"
- ],
- "type": "object"
- },
- "type": "array"
-}
removedOutput schema / properties / topPublications
Removed value: -{
- "items": {
- "additionalProperties": false,
- "properties": {
- "engagementRate": {
- "type": [
- "number",
- "null"
- ]
- },
- "impressions": {
- "type": [
- "number",
- "null"
- ]
- },
- "performanceScore": {
- "type": [
- "number",
- "null"
- ]
- },
- "platform": {
- "type": "string"
- },
- "publicationId": {
- "type": "string"
- },
- "rank": {
- "type": [
- "number",
- "null"
- ]
- },
- "reach": {
- "type": [
- "number",
- "null"
- ]
- },
- "roas": {
- "type": [
- "number",
- "null"
- ]
- },
- "spend": {
- "type": [
- "number",
- "null"
- ]
- }
- },
- "required": [
- "publicationId",
- "platform",
- "performanceScore",
- "rank",
- "reach",
- "impressions",
- "engagementRate",
- "spend",
- "roas"
- ],
- "type": "object"
- },
- "type": "array"
-}
changedOutput schema / required
Previous value: -[
- "windowDays",
- "currency",
- "hasData",
- "kpiTotals",
- "kpiTrends",
- "channels",
- "reachByChannel",
- "topPublications",
- "organicBaselines",
- "audience"
-]New value: +[
+ "windowDays",
+ "accounts"
+]