Export

Generate a downloadable CSV or PDF of your analytics for a workspace or a single account. Exports run asynchronously and are retrieved through the Job Status endpoint.

Requirements

• Authentication: Bearer API token
• Scope: analytics
• Headers:

  • Authorization: Bearer-API YOUR_API_KEY
  • Publer-Workspace-Id: YOUR_WORKSPACE_ID

Export Analytics

Create an analytics export job.

PUT /api/v1/analytics/export

The output format is specified using the nested format parameter, not a top-level format parameter. Any value other than csv produces a PDF.

Query Parameters

Parameter	Type	Required	Description
format	string	No	csv or pdf. Defaults to pdf.
account_id	string	No	Limit the export to one account. When omitted, the export covers all accounts in the workspace.
from	string	No	Start of the reporting period (ISO date)
to	string	No	End of the reporting period (ISO date)
tab	string	No	Analytics tab to export
account_type	string	No	Filter by account type
postType	string	No	Filter by post type
query	string	No	Full-text search on post content
member_id	string	No	Filter by workspace member
sort_by	string	No	Field to sort by
sort_type	string	No	Sort direction
labels[]	string[]	No	Filter by label IDs
columns[]	string[]	No	Columns to include in a CSV export

Export Analytics

put

Generates a CSV or PDF analytics export. Filters are sent as a JSON request body. The export is produced asynchronously; poll the returned job_id via the Job Status endpoint to retrieve the finished file.

Authorizations

AuthorizationstringRequired

API key authentication. Format: "Bearer-API YOUR_API_KEY"

Header parameters

Publer-Workspace-IdstringRequired

ID of the workspace to export analytics from

Body

formatstring · enumOptional

Output format. Anything other than "csv" produces a PDF.

Possible values:

fromstring · dateOptional

Start of the reporting period

tostring · dateOptional

End of the reporting period

tabstringOptional

Analytics tab to export, for example "overview"

account_idstringOptional

Limit the export to one account. When omitted, the export covers all accounts in the workspace.

account_typestringOptional

Filter by account type

postTypestringOptional

Filter by post type. May be null.

typestringOptional

Filter by type

querystringOptional

Full-text search on post content

member_idstringOptional

Filter by workspace member

sort_bystringOptional

Field to sort by

sort_typestringOptional

Sort direction

labelsstring[]Optional

Filter by label IDs

columnsstring[]Optional

Columns to include in a CSV export

Responses

200

Export job created successfully

application/json

successbooleanOptional

Whether the job was created successfully

Example: true

401

Unauthorized

application/json

403

Permission denied or missing required scope

application/json

put/analytics/export

PUT /api/v1/analytics/export HTTP/1.1
Host: app.publer.com
Authorization: YOUR_API_KEY
Publer-Workspace-Id: text
Content-Type: application/json
Accept: */*
Content-Length: 87

{
  "from": "2026-09-11",
  "to": "2026-09-17",
  "tab": "overview",
  "format": "pdf",
  "postType": null
}

{
  "success": true,
  "data": {
    "job_id": "6810dec617eae6d55d7a5e5b"
  }
}

Retrieving the export

The endpoint returns immediately with a job ID:

{ "job_id": "6810dec617eae6d55d7a5e5b" }

Poll it until the job completes:

GET /api/v1/job_status/6810dec617eae6d55d7a5e5b

Notes

• Only one export job runs at a time per user. Starting a second while one is still in progress returns an error.
• Omit account_id for a workspace-wide export across every connected account.
• columns[] applies to CSV exports only.

Related Resources

• Charts — Available analytics charts
• Post Insights — Per-post performance