Search media | Spyglass

import { Spyglass } from "@spyglasshq/sdk";
async function main() {
    const client = new Spyglass({
        token: "YOUR_TOKEN_HERE",
    });
    await client.searchMedia({
        query: "comfort-focused video ads",
        limit: 20,
    });
}
main();

{
  "count": 1,
  "media": [
    {
      "id": "string",
      "platformId": "string",
      "brand": {
        "id": "string",
        "facebookAdLibraryId": "string",
        "name": "string",
        "type": "BRAND",
        "igUsername": "string",
        "igFollowers": 1.1,
        "tiktokUsername": "string",
        "tiktokFollowers": 1.1,
        "facebookUsername": "string",
        "thumbnailUrl": "string",
        "category": "string"
      },
      "title": "string",
      "type": "DPA",
      "mediaType": "VIDEO",
      "url": "string",
      "urls": [
        "string"
      ],
      "thumbnailUrl": "string",
      "width": 1.1,
      "height": 1.1,
      "durationInSeconds": 1.1,
      "platforms": [
        "string"
      ],
      "hook": "string",
      "summary": "string",
      "coreAngle": "string",
      "targetPersona": "string",
      "ugcCharacter": {
        "ageRange": "0-18",
        "gender": "male",
        "ethnicity": "White",
        "description": "string"
      },
      "startAt": "string",
      "endAt": "string",
      "daysRun": 1.1,
      "categories": [
        "string"
      ],
      "carouselCount": 1.1,
      "viewCount": 1.1,
      "likeCount": 1.1,
      "commentCount": 1.1,
      "impressionPercentile": 1.1,
      "impressionsText": "string",
      "painPoints": [
        "string"
      ],
      "sellingPoints": [
        "string"
      ]
    }
  ]
}

Return creatives. Pass accountId to scope to one brand or creator, or omit it to search the whole corpus. Without accountId, query is required.

Limited to 120 requests per minute per user. Costs $0.0005 per creative returned, charged against your plan’s monthly credits. The count field is what you were charged for. The call bills a minimum of one row even when nothing matches. In that case count is 0 but you are charged for one row.

Authentication

AuthorizationBearer

An API key from Settings → API, prefixed sg_live_.

Request

This endpoint expects an object.

accountIdstring or doubleOptional

Account id given as a platform string or uuid

querystringOptional1-500 characters

channellist of enumsOptional

Allowed values:

formatlist of enumsOptional

Allowed values:

durationlist of enumsOptional

Allowed values:

statusenumOptional

Allowed values:

categorieslist of enumsOptional

taxonomylist of stringsOptional

funnelStagelist of enumsOptional

Allowed values:

languagelist of enumsOptional

locationlist of stringsOptional

datePresetenumOptional

startDatestringOptional

endDatestringOptional

minDaysRundoubleOptional

maxDaysRundoubleOptional

minViewCountdoubleOptional

maxViewCountdoubleOptional

landingPagestringOptional>=1 character

landingPageMatchenumOptional

Allowed values:

lowImpressionsbooleanOptional

partnershipAdbooleanOptional

crosspostedbooleanOptional

sortByenumOptional

limitintegerOptional1-2000Defaults to 100

offsetintegerOptional>=0

Response

Matching creatives.

countinteger

medialist of objects

Errors

400

Bad Request Error

401

Unauthorized Error

402

Payment Required Error

403

Forbidden Error

404

Not Found Error

405

Method Not Allowed Error

413

Content Too Large Error

429

Too Many Requests Error

500

Internal Server Error