Broadcasts

Broadcast status history

Status changes of the site's broadcasts: launches, pauses, stops, completions, oldest first; order=newest gives the latest first. Deleting a started broadcast stops it with reason=deleted; a deleted draft gets a draft entry with reason=deleted. Each entry names the broadcast, the status entered, where the change came from (source), why (reason, null when a person simply made the change) and the person who did it (author). Call it to answer why a broadcast is paused or stopped and who did it; broadcast_id keeps one broadcast. Broadcasts deleted since keep their entries, with the name they had. The last edit of a broadcast and its e-mails is edited_at and edited_by of get_broadcast.

get/v1/sites/{site_id}/broadcasts/history

Request

  • Base URL
    https://api.getsitecontrol.com
  • Auth
    HTTP bearer

Path parameters

site_idinteger required

Query parameters

broadcast_idinteger

Only this broadcast, id from list_broadcasts

cursorstring

next_cursor of the previous page, sent with the same order; omit for the first

limitinteger

Items per page

fieldsstring

Comma-separated fields to keep in each item, for example id,name; each item then carries only those fields and id. Omit for every field

order'oldest' | 'newest'

Order of a list. oldest: the oldest item first; newest: the newest item first, for the latest items without paging through the history.

Order of the items: oldest first (default) or newest first; asc and desc mean the same

Response

Successful Response

next_cursorstring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.