Analytics · Analytics
Fetches Facebook post monetization earnings.
GET
https://api.pozy.ai/v1/analytics/facebook/post-earningsgetFacebookPostEarnings
Guides: Facebook, Platform insights
Request
Send your API key as Authorization: Bearer pz_live_.... Read-only keys can call it. Keys with the analytics resource group disabled get 403 resource_group_disabled. Authentication
Query parameters
| Name | Type | Notes |
|---|---|---|
accountIdrequired | string | |
postIdrequired | string | |
metrics | string |
Example
curl -X GET "https://api.pozy.ai/v1/analytics/facebook/post-earnings?accountId=696e0b682d0a31188e7a2ba9&postId=6108a2cc742cb4e991051e0c" \
-H "Authorization: Bearer $POZY_API_KEY"const res = await fetch("https://api.pozy.ai/v1/analytics/facebook/post-earnings?accountId=696e0b682d0a31188e7a2ba9&postId=6108a2cc742cb4e991051e0c", {
headers: { Authorization: `Bearer ${process.env.POZY_API_KEY}` },
});
const data = await res.json();
if (!res.ok) throw new Error(data?.error ?? `Request failed with status ${res.status}`);
console.log(data);import os
import requests
resp = requests.get(
"https://api.pozy.ai/v1/analytics/facebook/post-earnings",
headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
params={
"accountId": "696e0b682d0a31188e7a2ba9",
"postId": "6108a2cc742cb4e991051e0c",
},
timeout=30,
)
resp.raise_for_status()
print(resp.json())Response
200 on success
successbooleanaccountIdstringpostIdstringplatformstringperiodstringOne of
lifetime.metricsmap of objectKeys are free-form; each value has these fields.
totalnumberunitstringOne of
micro_amount,unspecified.currencystringCan be null.
unavailableMetricsarray of objectmetricstringreasonstringOne of
not_enrolled,permission_missing,unsupported_metric,no_data,unreadable_value,mixed_currency,upstream_error.messagestring
dataDelaystring
200 response
{
"success": true,
"accountId": "696e0b682d0a31188e7a2ba9",
"postId": "6108a2cc742cb4e991051e0c",
"platform": "instagram",
"period": "lifetime",
"metrics": {
"key": {
"total": 12.5,
"unit": "micro_amount",
"currency": "USD"
}
},
"unavailableMetrics": [
{
"metric": "string",
"reason": "not_enrolled",
"message": "Hello from Pozy"
}
],
"dataDelay": "string"
}Errors
Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:
| 400 | invalid_request_error | A parameter or body field is missing or invalid. param names it. |
| 401 | authentication_error | The API key is missing, revoked or expired. |
| 403 | permission_error | The key is scoped to other profiles or has this resource group disabled. |
| 429 | rate_limit_error | Too many requests this minute. Wait for Retry-After seconds. |
Every code is listed in Errors.
More in Analytics
GETGet post analyticsGETAnalytics changed since a cursorGETGet YouTube channel insightsGETGet LinkedIn org analyticsGETGet TikTok account-level insightsGETGet YouTube daily viewsGETGet YouTube video retention curveGETGet Facebook Page insightsGETGet Instagram insightsGETGet Instagram follower historyGETGet Facebook Page demographicsGETGet LinkedIn organization follower demographicsGETGet Instagram demographicsGETGet Instagram online followersGETGet YouTube demographicsGETGet daily aggregated metricsGETGet an analytics dashboardGETGet best times to postGETGet content performance decayGETGet frequency vs engagementGETGet post analytics timelinePOSTRun a Google Analytics (GA4) reportPOSTRun a Google Analytics (GA4) realtime reportGETList Google Analytics (GA4) dimensions and metricsGETList tracking windowsPOSTOpen a tracking windowGETGet a tracking windowDELCancel a tracking windowGETGet post samplesGETGet a post's authenticity scoreGETList authenticity scoresGETGet Google Business Profile performance metricsGETGet Google Business Profile search keywordsPOSTSync an external postGETGet LinkedIn aggregate statsGETGet LinkedIn post statsGETGet LinkedIn post reactionsGETGet Facebook post reactionsGETList visitor posts on a Facebook PageGETList the posts a Facebook Page is tagged in