Import progress stream

Server-sent events with the import view every second until the import ends.

Scope items.read

Path parameters

idstringrequired

Responses

200Server-sent events

401Authentication required or API key invalid

403Permission or scope missing, organisation suspended

404Not found

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

otherError (RFC 9457 problem details)

Request

curl https://api.postbuddy.nl/v1/postbatches/pb_01J9Y2K8QF4T6W8Z0B2D4F6H8K/import/progress \
  -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.postbatches.importProgress('pb_01J9Y2K8QF4T6W8Z0B2D4F6H8K');

import os
from postbuddy import Client

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

result = client.postbatches.import_progress("pb_01J9Y2K8QF4T6W8Z0B2D4F6H8K")

Response

Server-sent events (text/event-stream)

{
  "type": "https://docs.postbuddy.nl/errors/not_found",
  "title": "Not found",
  "status": 404,
  "code": "not_found",
  "detail": "Not found",
  "requestId": "req_01J9Y2K8QF4T6W8Z0B2D4F6H8K"
}