Briefs

List briefs

Retrieves briefs with a plain-text excerpt (its variables marked as runs), their audience (everyone, or non-ended linked campaigns plus creators sent it directly), read progress at the current version, and sample video counts.

get/briefs

Request

  • Base URL: https://viral.app/api/v1
  • URL: https://viral.app/api/v1/briefs
  • Auth: API key in header x-api-key

Query parameters

searchstring

Search by brief name

Example:Hook Playbook
campaignIdsstring[]

Filter briefs by campaigns they are linked to

[
  "orgcamp_RwmraAffhMt9"
]
pagenumber

Page number (1-based index)

Example:1
perPagenumber

Number of items per page (1-100)

Example:10
sortColstring

Sort column

Example:publishedAt
sortDir'asc' | 'desc'

Sort direction

Example:asc

Response

OK

pageCountnumber required

Total number of pages

totalRowsnumber required

Total number of rows

Example response

{
  "data": [
    {
      "id": "orgbrief_RwmraAffhMt9",
      "campaigns": [
        {
          "id": "orgcamp_RwmraAffhMt9",
          "status": "active"
        }
      ],
      "audience": {
        "campaigns": [
          {
            "id": "orgcamp_RwmraAffhMt9",
            "status": "active"
          }
        ]
      }
    }
  ]
}

Changes

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