Skip to content

post/export

Exports posts as CSV.

Overview

Use this endpoint to export a filtered post dataset.

Authentication

Authentication is required. See Authentication.

Permissions

Authentication is required.

Endpoint

post/export

Purpose

Returns filtered posts serialized as CSV content.

Method and path

POST /post/export

Headers

HeaderRequiredDescription
X-Api-Key or X_API_KEYyesAPI key.
Content-Typeyesapplication/json.

Request body

FieldTypeRequiredDescription
project_idintegeryesProject identifier.
orderBystringnoSort field. Default post_time.
orderDirstringnoSort direction. Default DESC.
limitintegernoMax rows. -1 means all matching rows.
offsetintegernoPagination offset.
Shared filtersmixednoParsed and applied by the shared filter system.

Example request

bash
curl -X POST "$SIGNAL_API_BASE_URL/post/export" \
  -H "X-Api-Key: $SIGNAL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "project_id": 123,
    "limit": 500,
    "orderBy": "post_time",
    "orderDir": "DESC"
  }'
json
{
  "project_id": 123,
  "limit": 500,
  "orderBy": "post_time",
  "orderDir": "DESC"
}

Example response

text
"from","text","url","engagement","sentiment","time (UTC)","platform","language"
"account","post text","https://example.org/post","123","neu","2026-05-11 10:00:00","X","en"

Notes

  • Response content type is text/csv.
  • Backend removes line breaks and some punctuation from exported text fields.

Doc rev.1.12.3 2026.05.08