Export Creatives

Queue a Google Sheet of the creatives this filter matches, and answer with what it will hold. A worker builds the sheet and DMs its link in Slack: a full export walks the feed to its end and uploads tens of megabytes, which is not a thing to hold a request open for.

columns are the table’s own keys, in the order they should appear; empty means every column the shared spec holds. query, sort and task_id are GET /creatives’ params verbatim, so an export is the rows on screen rather than a second definition of them.

POST/api/v1/exports/creatives

Authorization

AuthorizationBearer token · headerrequired

AuthorizationOAuth2 access token · headerrequired

Request body

requiredapplication/json

columnsstring[]

column keys, in order; empty means all of them

querystring | any

react-querybuilder rule group as a JSON string

Show properties

Any of:

string

string

any

any

sortstring | any

sort as JSON: {"field": ..., "direction": 1|-1}

Show properties

Any of:

string

string

any

any

searchstring | any

tasks only: the toolbar's search term

Show properties

Any of:

string

string

any

any

task_idstring | any

creatives only: only this task's creatives

Show properties

Any of:

string

string

any

any

titlestring | any

spreadsheet name; defaults to a stamped one

Show properties

Any of:

string

string

any

any

Responses

202Successful Response

successboolean

default: true

dataExportAccepted | any

Show properties

Any of:

ExportAccepted

entitystringrequired

Allowed:creativestasks

rowsintegerrequired

columnsstring[]required

any

any

messagestring | any

Show properties

Any of:

string

string

any

any

errorsstring[] | any

Show properties

Any of:

string[]

Array of string

string

any

any

422Validation Error

detailValidationError[]

Show properties

Array of ValidationError

locstring | integer[]required

Show properties

Array of string | integer

Any of:

string

string

integer

integer

msgstringrequired

typestringrequired

inputany

ctxobject

Request

curl -X POST "/api/v1/exports/creatives" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "columns": [
    "string"
  ],
  "query": "string",
  "sort": "string",
  "search": "string",
  "task_id": "string",
  "title": "string"
}'

const response = await fetch("/api/v1/exports/creatives", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "columns": [
    "string"
  ],
  "query": "string",
  "sort": "string",
  "search": "string",
  "task_id": "string",
  "title": "string"
})
});

import requests

response = requests.post(
    "/api/v1/exports/creatives",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    json={
  "columns": [
    "string"
  ],
  "query": "string",
  "sort": "string",
  "search": "string",
  "task_id": "string",
  "title": "string"
},
)

Response

{
  "success": true,
  "data": {
    "entity": "creatives",
    "rows": 0,
    "columns": [
      "string"
    ]
  },
  "message": "string",
  "errors": [
    "string"
  ]
}