API reference · Analytics
Read analytics methodology
GET /v1/analytics/methodology
Machine-readable definitions for normalised metrics, coverage, freshness, availability, comparisons, and per-network reporting. Read this before comparing metrics across networks or explaining a zero.
Request
Authenticate with a bearer API key. MCP get_analytics includes a link to these definitions, but there is no separate MCP methodology tool.
curl -X GET https://api.postlake.dev/v1/analytics/methodology \
-H "Authorization: Bearer $POSTLAKE_API_KEY"Response
Success (200).
| Field | Type | Required | What it is |
|---|---|---|---|
version | integer | Yes | |
scope | string | Yes | |
freshness | string | Yes | |
totals | string | Yes | |
engagement | string | Yes | |
engagementRate | string | Yes | |
ctr | string | Yes | |
comparisons | string | Yes | |
timeseries | string | Yes | |
availability | string | Yes | |
profileFilter | string | Yes | |
accountInsights | string | Yes | |
reportsByPlatform | object | Yes |
Example
{
"version": 0,
"scope": "…",
"freshness": "…",
"totals": "…",
"engagement": "…",
"engagementRate": "…",
"ctr": "…",
"comparisons": "…"
}What it costs
This read-only definition request spends no publishing or network-read credits. Normal account read rate limits still apply.
Calling this from an agent
There is no separate MCP methodology tool. The hosted MCP get_analytics response includes methodologyUrl; an agent with an API key can read the definitions through this REST endpoint.
Errors
Every failure uses one shape: a stable type, a granular code, the field at fault in param, and a plain-language fix. An agent can act on it without a person reading the message. See Errors and retries.
Idempotency-Key.Common questions
Can an AI agent read these rules?
Yes. The MCP get_analytics response includes methodologyUrl. The definitions themselves are available through this authenticated REST endpoint.
How often can I call this?
Reads are rate limited per account and every response carries X-RateLimit-Remaining and X-RateLimit-Reset. On a 429 the Retry-After header tells you how long to wait.
What happens when it fails?
You get one error shape: a stable type, a granular code you can branch on, the offending field in param, and a fix written so an agent can correct itself rather than stop. Full list on Errors and retries.