List Frame Analyses

GET/api/v1/frame-analyses

Authorization

AuthorizationBearer token · headerrequired

AuthorizationOAuth2 access token · headerrequired

Query parameters

limitinteger

min 1 · max 100 · default: 20

offsetinteger

min 0 · default: 0

Responses

200Successful Response

successboolean

default: true

dataFrameAnalysisRunList | any

Show properties

Any of:

FrameAnalysisRunList

runsFrameAnalysisRunSummary[]required

Show properties

Array of FrameAnalysisRunSummary

idstringrequired

weekstringrequired

week_startstring<date>required

week_endstring<date>required

productsstring[]required

creative_countintegerrequired

statusFrameAnalysisRunStatusrequired

Allowed:queuedrunningdonefailed

created_atstring<date-time>required

metaPaginationMetarequired

Show properties

totalintegerrequired

limitintegerrequired

offsetintegerrequired

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 GET "/api/v1/frame-analyses" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("/api/v1/frame-analyses", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "/api/v1/frame-analyses",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "success": true,
  "data": {
    "runs": [
      {
        "id": "string",
        "week": "string",
        "week_start": "2019-08-24",
        "week_end": "2019-08-24",
        "products": [
          "string"
        ],
        "creative_count": 0,
        "status": "queued",
        "created_at": "2019-08-24T14:15:22Z"
      }
    ],
    "meta": {
      "total": 0,
      "limit": 0,
      "offset": 0
    }
  },
  "message": "string",
  "errors": [
    "string"
  ]
}