Get Packs

The packs whose work is finished — done and archived — newest completion first, each with the creatives that have a file to upload.

Page with limit and cursor: while more packs remain the response carries the next cursor in the X-Next-Cursor header, and its absence ends the stream. Poll with created_after set to the newest completed_at already seen; a pack that never went through the workflow has no completion date and arrives after everything that has one.

A pack whose creatives are all still un-synced is not returned at all: it would be indistinguishable from one that lost them.

GET/api/v1/integrations/creative-tests/packs

Authorization

AuthorizationBearer token · headerrequired

Static token issued to an integrating platform (INTEGRATIONS__TOKENS)

Query parameters

projectstring | any

product the pack belongs to, e.g. `CNI`

sourceSource | any

ad source the pack was briefed for

created_afterstring<date-time> | any

only packs completed at or after this instant — the polling cursor

media_typeKumquatMediaType | any

geoGeo | any

localeLanguage | any

limitinteger

min 1 · max 200 · default: 50

cursorstring | any

opaque keyset cursor from the previous page

Responses

200Successful Response

Array of KumquatPack

idstringrequired

namestringrequired

localeLanguagerequired

Allowed:ENFRDEPTESUACA-FRITUKTRPLJAHEMXBRDANOCHSVNLBEIEATCSROHIBGZHKOEL

geoGeo | any

Show properties

Any of:

Geo

string

any

any

creativesKumquatCreative[]

Show properties

Array of KumquatCreative

idstringrequired

namestringrequired

localeLanguagerequired

Allowed:ENFRDEPTESUACA-FRITUKTRPLJAHEMXBRDANOCHSVNLBEIEATCSROHIBGZHKOEL

geoGeo | any

Show properties

Any of:

Geo

string

any

any

task_typeTaskTyperequired

Allowed:NEWVARLOCWHTNEWDESVARDESDESCLNVARAIADPTRSZ

media_typeKumquatMediaTyperequired

What an ad account has to know about a file: whether it is a still or a moving image. A playable is neither, and has no value here — see `_to_creative`, which leaves those out rather than mislabelling them.

Allowed:staticvideo

assetKumquatAssetrequired

A binary stored by Kumquat: the creative media itself or its thumbnail. `file_name` carries the extension, so downloads keep a name Meta and S3 accept even when the creative name has none at all.

Show properties

file_namestringrequired

urlstring | any

Show properties

Any of:

string

string

any

any

poster_urlstring | any

Show properties

Any of:

string

string

any

any

sha256string | any

Show properties

Any of:

string

string

any

any

mime_typestring | any

Show properties

Any of:

string

string

any

any

size_bytesinteger | any

Show properties

Any of:

integer

integer

any

any

aspect_ratioAspectRatio | any

Show properties

Any of:

AspectRatio

string

any

any

resolutionResolution | any

Show properties

Any of:

Resolution

string

any

any

subjectstring | any

Show properties

Any of:

string

string

any

any

subtopicsstring[]

topicstring | any

Show properties

Any of:

string

string

any

any

funnelany

Show properties

Any of:

any

any

any

any

cppany

Show properties

Any of:

any

any

any

any

ad_formatAdFormat | any

Show properties

Any of:

AdFormat

string

any

any

hypothesisstring | any

Show properties

Any of:

string

string

any

any

hook_typeHookType | any

Show properties

Any of:

HookType

string

any

any

hook_triggerHookTrigger | any

Show properties

Any of:

HookTrigger

string

any

any

traffic_flowTrafficFlow | any

Show properties

Any of:

TrafficFlow

string

any

any

landingany

Show properties

Any of:

any

any

any

any

created_atstring<date-time> | any

Show properties

Any of:

string<date-time>

string<date-time>

any

any

product_namestring | any

Show properties

Any of:

string

string

any

any

created_atstring<date-time> | any

Show properties

Any of:

string<date-time>

string<date-time>

any

any

completed_atstring<date-time> | any

Show properties

Any of:

string<date-time>

string<date-time>

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 GET "/api/v1/integrations/creative-tests/packs" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("/api/v1/integrations/creative-tests/packs", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "/api/v1/integrations/creative-tests/packs",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

[
  {
    "id": "string",
    "name": "string",
    "locale": "EN",
    "geo": "US",
    "creatives": [
      {
        "id": "string",
        "name": "string",
        "locale": "EN",
        "geo": "US",
        "task_type": "NEW",
        "media_type": "static",
        "asset": {
          "file_name": "string",
          "url": "string",
          "poster_url": "string",
          "sha256": "string",
          "mime_type": "string",
          "size_bytes": 0
        },
        "aspect_ratio": "16x9",
        "resolution": "1080x1920",
        "subject": "string",
        "subtopics": [
          "string"
        ],
        "topic": "string",
        "funnel": {},
        "cpp": {},
        "ad_format": "animation",
        "hypothesis": "string",
        "hook_type": "pattern_interrupt",
        "hook_trigger": "pattern_interrupt",
        "traffic_flow": "W2A",
        "landing": {},
        "created_at": "2019-08-24T14:15:22Z"
      }
    ],
    "product_name": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "completed_at": "2019-08-24T14:15:22Z"
  }
]