# Request background analytics refresh

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

`POST /v1/analytics/refresh`

Queue a workspace analytics refresh and return immediately. Requests are deduplicated while a job is active, with a five-minute start cooldown. Optional ifStale=true reuses a collection updated within fifteen minutes; the dashboard uses it once on entry without restarting collection on filter changes. Recent eligible content is checked first through bounded continuations on a separate queue. During reliability incidents, collection can be paused: new requests return 503, analytics_refresh_unavailable and Retry-After: 60. Stored reports remain available. The same explicit refresh operation is available through get_analytics with refresh=true in MCP.

## Request

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

```bash
curl -X POST https://api.postlake.dev/v1/analytics/refresh \
  -H "Authorization: Bearer $POSTLAKE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"ifStale":true}'
```

### Body

| Field | Type | Required | What it is |
| --- | --- | --- | --- |
| `ifStale` | boolean | No | Reuse a recently updated collection instead of starting another job. Automatic-entry freshness interval is fifteen minutes; provider eligibility and cooldowns still apply. |


## Response

Queued, already active, or within the start cooldown (`202`).

| Field | Type | Required | What it is |
| --- | --- | --- | --- |
| `jobId` | string | No |  |
| `state` | string (queued, running, complete, failed) | No |  |
| `startedAt` | string | No |  |
| `updatedAt` | string | No |  |
| `posts` | integer | No |  |
| `errors` | integer | No |  |
| `cursor` | string or null | No |  |



### Example

```json
{
  "jobId": "…",
  "state": "queued",
  "startedAt": "2026-08-16T07:00:00Z",
  "updatedAt": "2026-08-16T07:00:00Z",
  "posts": 0,
  "errors": 0,
  "cursor": "…"
}
```


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

**Is it safe to retry this call?**

Do not automatically repeat a write after a timeout unless that endpoint explicitly documents idempotency. First read the resulting state; a second request could repeat the action.

**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 analytics refresh progress](https://docs.postlake.dev/api/get-analytics-refresh.md) `GET /v1/analytics/refresh`
- [Get post analytics](https://docs.postlake.dev/api/get-posts-by-id-analytics.md) `GET /v1/posts/{id}/analytics`