GET/v1/analytics/items.csv

Items of a period as CSV

Up to ten thousand items with their statuses, timestamps and unit prices, newest first; the same filters as the summary.

Scope items.readRate limit class export

Query parameters

fromdate

todate

daysintegermin 1max 366

postflowIdstringmax length 40

postbatchIdstringmax length 40

Responses

200The items as CSV

401Authentication required or API key invalid

403Permission or scope missing, organisation suspended

422Validation failed

429Rate limited for this API key and class; wait Retry-After seconds

otherError (RFC 9457 problem details)

Request

curl https://api.postbuddy.nl/v1/analytics/items.csv \
  -H "Authorization: Bearer $POSTBUDDY_API_KEY"

import { PostBuddyClient } from '@postbuddy/sdk';

const client = new PostBuddyClient({ apiKey: process.env.POSTBUDDY_API_KEY! });

const result = await client.analytics.exportCsv();

import os
from postbuddy import Client

client = Client(os.environ["POSTBUDDY_API_KEY"])

result = client.analytics.export_csv()

Response

The items as CSV (text/csv)

{
  "type": "https://docs.postbuddy.nl/errors/validation_failed",
  "title": "Validation failed",
  "status": 422,
  "code": "validation_failed",
  "detail": "Validation failed",
  "requestId": "req_01J9Y2K8QF4T6W8Z0B2D4F6H8K",
  "errors": [
    {
      "field": "recipient.postalCode",
      "code": "invalid_string",
      "message": "Invalid postal code"
    }
  ]
}