Preview Frame Analysis

Candidate counts for the New/test block at a few benchmark floors, so the create form can show “N creatives at this benchmark” before the run is committed.

POST/api/v1/frame-analyses/preview

Authorization

AuthorizationBearer token · headerrequired

AuthorizationOAuth2 access token · headerrequired

Request body

requiredapplication/json

week_startstring<date>required

week_endstring<date>required

media_sourcestring | any

Show properties

Any of:

string

string

any

any

productsstring[]required

min items 1

floorsinteger[] | any

Show properties

Any of:

integer[]

Array of integer

integer

any

any

Responses

200Successful Response

successboolean

default: true

dataFrameAnalysisPreviewResult | any

Show properties

Any of:

FrameAnalysisPreviewResult

countsBenchmarkCount[]required

Show properties

Array of BenchmarkCount

floorintegerrequired

countintegerrequired

unmapped_productsstring[]

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/frame-analyses/preview" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "week_start": "2019-08-24",
  "week_end": "2019-08-24",
  "media_source": "string",
  "products": [
    "string"
  ],
  "floors": [
    0
  ]
}'

const response = await fetch("/api/v1/frame-analyses/preview", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "week_start": "2019-08-24",
  "week_end": "2019-08-24",
  "media_source": "string",
  "products": [
    "string"
  ],
  "floors": [
    0
  ]
})
});

import requests

response = requests.post(
    "/api/v1/frame-analyses/preview",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    json={
  "week_start": "2019-08-24",
  "week_end": "2019-08-24",
  "media_source": "string",
  "products": [
    "string"
  ],
  "floors": [
    0
  ]
},
)

Response

{
  "success": true,
  "data": {
    "counts": [
      {
        "floor": 0,
        "count": 0
      }
    ],
    "unmapped_products": [
      "string"
    ]
  },
  "message": "string",
  "errors": [
    "string"
  ]
}