Create Frame Analysis

Answers before the run is built: selection is several ClickHouse queries, run by the io worker (build_frame_analysis) rather than inside this request.

POST/api/v1/frame-analyses

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

new_purchase_floorintegerrequired

Chosen from a preceding /preview call

min 1

top_purchase_floorinteger

min 1 · default: 100

top_capinteger

min 1 · max 20 · default: 7

Responses

200Successful Response

successboolean

default: true

dataFrameAnalysisRunDetail | any

Show properties

Any of:

FrameAnalysisRunDetail

idstringrequired

weekstringrequired

week_startstring<date>required

week_endstring<date>required

media_sourcestring | any

Show properties

Any of:

string

string

any

any

statusFrameAnalysisRunStatusrequired

Allowed:queuedrunningdonefailed

created_atstring<date-time>required

creativesFrameAnalysisCreativeOut[]required

Show properties

Array of FrameAnalysisCreativeOut

creative_idstringrequired

namestringrequired

product_idstringrequired

categoryCreativeCategoryrequired

Allowed:topnew

tierstring | anyrequired

Show properties

Any of:

string

string

any

any

mediaCreativeMediaOut | anyrequired

Show properties

Any of:

CreativeMediaOut

kindstringrequired

Allowed:videostatic

frame_urlsstring[] | any

Show properties

Any of:

string[]

Array of string

string

any

any

image_urlstring | any

Show properties

Any of:

string

string

any

any

video_urlstring | any

Show properties

Any of:

string

string

any

any

preview_urlstring | any

Show properties

Any of:

string

string

any

any

duration_msinteger | any

Show properties

Any of:

integer

integer

any

any

widthinteger | any

Show properties

Any of:

integer

integer

any

any

heightinteger | any

Show properties

Any of:

integer

integer

any

any

analyzingboolean

default: false

any

any

platformsPlatformMetrics[]required

Show properties

Array of PlatformMetrics

platformstringrequired

metricsMetricSnapshot[]

Show properties

Array of MetricSnapshot

keystringrequired

labelstringrequired

unitMetricUnitrequired

Allowed:usdpercentratiocount

currentnumberrequired

previousnumberrequired

up_is_goodboolean

default: true

varied_fieldsVariedField[]required

Show properties

Array of VariedField

labelstringrequired

valuestringrequired

content_summarystring | anyrequired

Show properties

Any of:

string

string

any

any

performance_summarystring | anyrequired

Show properties

Any of:

string

string

any

any

ideasIdea[]required

Show properties

Array of Idea

idstring

textstringrequired

doneboolean

default: false

created_atstring<date-time>

task_idstringrequired

task_namestring | anyrequired

Show properties

Any of:

string

string

any

any

task_owner_idstring | anyrequired

Show properties

Any of:

string

string

any

any

assignee_idstring | anyrequired

Show properties

Any of:

string

string

any

any

created_atstring<date-time>required

includedUserIncludes

People referenced by the payload, keyed by id — same contract as `CreativeIncludes`. Comment authors, mentions and reactors on the comments feed, transition actors on the history one.

Show properties

usersobject

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" \
  -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"
  ],
  "new_purchase_floor": 1,
  "top_purchase_floor": 100,
  "top_cap": 7
}'

const response = await fetch("/api/v1/frame-analyses", {
  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"
  ],
  "new_purchase_floor": 1,
  "top_purchase_floor": 100,
  "top_cap": 7
})
});

import requests

response = requests.post(
    "/api/v1/frame-analyses",
    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"
  ],
  "new_purchase_floor": 1,
  "top_purchase_floor": 100,
  "top_cap": 7
},
)

Response

{
  "success": true,
  "data": {
    "id": "string",
    "week": "string",
    "week_start": "2019-08-24",
    "week_end": "2019-08-24",
    "media_source": "string",
    "status": "queued",
    "created_at": "2019-08-24T14:15:22Z",
    "creatives": [
      {
        "creative_id": "string",
        "name": "string",
        "product_id": "string",
        "category": "top",
        "tier": "string",
        "media": {
          "kind": "video",
          "frame_urls": [
            "string"
          ],
          "image_url": "string",
          "video_url": "string",
          "preview_url": "string",
          "duration_ms": 0,
          "width": 0,
          "height": 0,
          "analyzing": false
        },
        "platforms": [
          {
            "platform": "string",
            "metrics": [
              {
                "key": "string",
                "label": "string",
                "unit": "usd",
                "current": 0,
                "previous": 0,
                "up_is_good": true
              }
            ]
          }
        ],
        "varied_fields": [
          {
            "label": "string",
            "value": "string"
          }
        ],
        "content_summary": "string",
        "performance_summary": "string",
        "ideas": [
          {
            "id": "string",
            "text": "string",
            "done": false,
            "created_at": "2019-08-24T14:15:22Z"
          }
        ],
        "task_id": "string",
        "task_name": "string",
        "task_owner_id": "string",
        "assignee_id": "string",
        "created_at": "2019-08-24T14:15:22Z"
      }
    ],
    "included": {
      "users": {
        "property1": {
          "id": "string",
          "name": "string",
          "email": "string",
          "image_url": "string"
        },
        "property2": {
          "id": "string",
          "name": "string",
          "email": "string",
          "image_url": "string"
        }
      }
    }
  },
  "message": "string",
  "errors": [
    "string"
  ]
}