# Get analytics refresh progress

> Markdown version of https://docs.postlake.dev/api/get-analytics-refresh . The canonical page for humans.
> PostLake is the social media API for AI agents: https://postlake.dev/llms.txt

`GET /v1/analytics/refresh`

Read the most recent workspace refresh state. Null means no refresh has been requested. collectionPaused is true while collection is suspended for service reliability; an existing queued or running job is not necessarily advancing. Complete means eligible collection finished, not that every provider returned every metric. errors counts unavailable readings; prior valid readings are preserved. MCP get_analytics includes this status in its response. Completion invalidates private saved reports immediately; measuredAt remains the metric collection timestamp.

## Request

Authenticate with a bearer API key. Agents calling over MCP authorise with OAuth instead and never handle the key.

```bash
curl -X GET https://api.postlake.dev/v1/analytics/refresh \
  -H "Authorization: Bearer $POSTLAKE_API_KEY"
```


## Response

Progress or null (`200`).



### Example

```json
"…"
```


## Calling this from an agent

Agents do not call REST. They call tools. Over the hosted MCP server this operation is `get_analytics`, and the agent authorises with OAuth so your API key is never pasted into a chat or seen by the model. You control what any one agent may do: which brands it may act for, which networks it may reach, how much a day, and whether it may spend credits bought up front.

## Errors

Every failure uses one shape: a stable `type`, a granular `code`, the field at fault in `param`, and a plain-language `fix`. See https://docs.postlake.dev/errors.md .

Check the result before retrying a write. Only operations that explicitly support idempotency can safely replay an `Idempotency-Key`.

## Common questions

**Can an AI agent do this without the REST API?**

Yes. Over MCP the same job is the get_analytics tool. The agent authorises with OAuth, so no API key is pasted into a chat or seen by the model, and the answer comes back in the same normalised shape.

**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.

## Related

- [Get cross-platform analytics](https://docs.postlake.dev/api/get-analytics.md) `GET /v1/analytics`
- [Read analytics methodology](https://docs.postlake.dev/api/get-analytics-methodology.md) `GET /v1/analytics/methodology`
- [Get post analytics](https://docs.postlake.dev/api/get-posts-by-id-analytics.md) `GET /v1/posts/{id}/analytics`
- [Request background analytics refresh](https://docs.postlake.dev/api/post-analytics-refresh.md) `POST /v1/analytics/refresh`