/snapchat/lenses/spotlights

POST /api/snapchat/lenses/spotlights

Price: 10 credits

Get Spotlight videos made with a Snapchat Lens

How to use it

Get the Spotlight videos Snapchat shows on a Lens page as made with that Lens, up to 16, with creator username, caption, upload time and duration. Pass an id to snapchat/spotlights for engagement counters.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• lens string required — Lens id (32-character hex or numeric) or snapchat.com Lens URL (examples: "565e7595ec4e4a0da689762b127308ef")
• count integer required — Max number of results (examples: 16; min: 1)

Response

• @type string (default: "SnapchatSpotlight")
• id string required
• url string required
• summary string nullable
• description string nullable
• caption string nullable
• keywords array (default: [])
• topics array (default: [])
• hashtags array (default: [])
• created_at integer nullable
• duration number nullable
• width integer nullable
• height integer nullable
• video_url string nullable
• thumbnail_url string nullable
• transcript_url string nullable
• view_count integer nullable
• share_count integer nullable
• comment_count integer nullable
• boost_count integer nullable
• recommend_count integer nullable
• creator object nullable
  • @type string (default: "SnapchatCreator")
  • alias string nullable
  • name string nullable
  • url string nullable
  • website_url string nullable
  • user_id string nullable
  • business_profile_id string nullable
  • image string nullable
  • has_badge boolean nullable
• sound object nullable
  • @type string (default: "SnapchatSpotlightSound")
  • id string nullable
  • name string nullable
  • artist string nullable
  • thumbnail_url string nullable
• lens object nullable
  • @type string (default: "SnapchatSpotlightLens")
  • id string nullable
  • name string nullable
  • url string nullable
  • thumbnail_url string nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — Lens not found. Verify the id or URL. Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.