Briefs

Get a brief's read status

Lists the creators who read a brief: per creator the routes it reaches them through (campaign, sent directly, everyone), whether they read the current version, an earlier one, or not yet, and when they were last notified. Counts cover the whole audience; creators who have not joined the organization yet are only counted.

get/briefs/{id}/read-status

Request

  • Base URL: https://viral.app/api/v1
  • URL: https://viral.app/api/v1/briefs/{id}/read-status
  • Auth: API key in header x-api-key

Path parameters

idstring required

Campaign brief ID with orgbrief_ prefix

Example:orgbrief_RwmraAffhMt9

Query parameters

searchstring

Search by creator name or email

Example:jane
filter'all' | 'unread'

unread keeps the creators who have not read the current version (earlier readers included)

Example:unread
pagenumber

Page number (1-based index)

Example:1
perPageinteger

Number of creators per page (1-500)

Example:100

Response

OK

versioninteger required
pageCountnumber required

Total number of pages

totalRowsnumber required

Total number of rows

Example response

{
  "creators": [
    {
      "routes": [
        {
          "campaignId": "orgcamp_RwmraAffhMt9"
        }
      ]
    }
  ]
}

Changes

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