StableSocial

Admitted input schema

{
  "type": "object",
  "properties": {
    "companyName": {
      "type": "string",
      "minLength": 0,
      "maxLength": 4096,
      "description": "The name of the company. Can either use this or pageId"
    },
    "country": {
      "type": "string",
      "minLength": 0,
      "maxLength": 4096,
      "description": "This can only be one country. It has to be the 2 letter code for the country. It defaults to ALL."
    },
    "cursor": {
      "type": "string",
      "minLength": 0,
      "maxLength": 4096,
      "description": "Cursor to paginate through results"
    },
    "end_date": {
      "type": "string",
      "minLength": 0,
      "maxLength": 4096,
      "description": "End date to search for. Format: YYYY-MM-DD"
    },
    "language": {
      "type": "string",
      "minLength": 0,
      "maxLength": 4096,
      "description": "Language to filter ads on. Needs to be 2 letter language code, ie EN, ES, FR, etc"
    },
    "media_type": {
      "type": "string",
      "minLength": 0,
      "maxLength": 4096,
      "enum": [
        "ALL",
        "IMAGE",
        "VIDEO",
        "MEME",
        "IMAGE_AND_MEME",
        "NONE"
      ],
      "description": "Media type of the ad. Defaults to ALL. Meme refers to ads with image and text. Not sure why they call it meme."
    },
    "pageId": {
      "type": "string",
      "minLength": 0,
      "maxLength": 4096,
      "description": "The companies ad library page id. You can get this with my Search For Companies Endpoint. Can either use this or companyName"
    },
    "sort_by": {
      "type": "string",
      "minLength": 0,
      "maxLength": 4096,
      "enum": [
        "total_impressions",
        "relevancy_monthly_grouped"
      ],
      "description": "Sort by impressions (high to low), or Most Recent (relevancy_monthly_grouped). Defaults to impressions."
    },
    "start_date": {
      "type": "string",
      "minLength": 0,
      "maxLength": 4096,
      "description": "Start date to search for. Format: YYYY-MM-DD"
    },
    "status": {
      "type": "string",
      "minLength": 0,
      "maxLength": 4096,
      "enum": [
        "ALL",
        "ACTIVE",
        "INACTIVE"
      ],
      "description": "Status of the ad. Defaults to ACTIVE."
    },
    "trim": {
      "type": "boolean",
      "description": "Set to true for a trimmed down version of the response"
    }
  },
  "required": [],
  "additionalProperties": false
}