\n ⚠️ Due to recent changes on TikTok's side, this API method has been affected. \n As a result, when paging comments, you may encounter duplicate comments.\n
We need some time to fix it. If you have any questions or need further assistance, please feel free to contact us. \n We appreciate your patience and understanding.\n
\n\n\nReturns TikTok comments list by media ID.\n\n### $ Paid request\n\nEvery successfully made request costs 0.002 tokens.\nSuccessful means we got some non-500 response from TikTok. For example, if you have passed an invalid postId, but TikTok returned not found error, then it counts as one request. If there are some problems on our side, then you would not be charged.",
"tags": [
"TikTok Raw API"
],
"parameters": [
{
"name": "url",
"in": "query",
"description": "TikTok media ID or link to video's page.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "after",
"in": "query",
"description": "Pass content of `cursor` field from the last response to get next page",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TiktokCommentsResponse"
}
}
},
"headers": {
"X-Tokens-Cost": {
"description": "The number of spent tokens",
"type": "number"
}
}
}
},
"x-stoplight": {
"id": "tucbowwv0jcau"
}
}
},
"/raw/tt/music/feed/": {
"parameters": [],
"get": {
"operationId": "tt-music-feed",
"summary": "TikTok Music Feed",
"description": "\nReturns TikTok music feed information by its ID.\nUp to 30 posts on the page.\n\n### $ Paid request\n\nEvery successfully made request costs 0.002 tokens.\nSuccessful means we got some non-500 response from TikTok. For example, if you have passed an invalid musicId, but TikTok returned not found error, then it counts as one request. If there are some problems on our side, then you would not be charged.",
"tags": [
"TikTok Raw API"
],
"parameters": [
{
"name": "url",
"in": "query",
"description": "TikTok musicId or link to music's page.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "after",
"in": "query",
"description": "Pass content of `cursor` field from the last response to get next page",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TiktokMusicFeedResponse"
}
}
},
"headers": {
"X-Tokens-Cost": {
"description": "The number of spent tokens",
"type": "number"
}
}
}
},
"x-stoplight": {
"id": "1m2inubgihrqa"
}
}
},
"/raw/tt/music/info/": {
"parameters": [],
"get": {
"operationId": "tt-music-info",
"summary": "TikTok Music Info",
"description": "\nReturns TikTok music information by ID.\n\n### $ Paid request\n\nEvery successfully made request costs 0.002 tokens.\nSuccessful means we got some non-500 response from TikTok. For example, if you have passed an invalid musicId, but TikTok returned not found error, then it counts as one request. If there are some problems on our side, then you would not be charged.",
"tags": [
"TikTok Raw API"
],
"parameters": [
{
"name": "url",
"in": "query",
"description": "TikTok musicId or link to music's page.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TiktokMusicInfoResponse"
}
}
},
"headers": {
"X-Tokens-Cost": {
"description": "The number of spent tokens",
"type": "number"
}
}
}
},
"x-stoplight": {
"id": "ec03tn3pmbe1k"
}
}
},
"/raw/tt/reply/comments/": {
"parameters": [],
"get": {
"operationId": "tt-reply-comments",
"summary": "TikTok Comments Replies",
"description": "\nReturns TikTok replies comments list by comment ID.\n\n### $ Paid request\n\nEvery successfully made request costs 0.002 tokens.\nSuccessful means we got some non-500 response from TikTok. For example, if you have passed an invalid userId, but TikTok returned not found error, then it counts as one request. If there are some problems on our side, then you would not be charged.\n",
"tags": [
"TikTok Raw API"
],
"parameters": [
{
"name": "url",
"in": "query",
"description": "TikTok media ID or link to video's page.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "comment_id",
"in": "query",
"description": "TikTok comment ID (`cid`) from 'TikTok Comments' API response.",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "after",
"in": "query",
"description": "Pass content of `cursor` field from the last response to get next page",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TiktokCommentsResponse"
}
}
},
"headers": {
"X-Tokens-Cost": {
"description": "The number of spent tokens",
"type": "number"
}
}
}
},
"x-stoplight": {
"id": "2ary21lc0tbtl"
}
}
},
"/raw/tt/resolve_short_link/": {
"parameters": [],
"get": {
"operationId": "tt-short-link-resolve",
"summary": "TikTok Short Link Resolve",
"description": "\nParses TikTok shortlinks like `https://vm.tiktok.com/abcd/`, `https://vt.tiktok.com/abcd/` and `https://www.tiktok.com/t/abcd/` and returns info about where this shortlink leads to.\n\n### $ Paid request\n\nEvery successfully made request costs 0.002 tokens.\nSuccessful means we got some non-500 response from TikTok. For example, if you have passed an invalid shortlink and TikTok returned not found error, then it counts as one request. If there are some problems on our side, then you would not be charged.",
"tags": [
"TikTok Raw API"
],
"parameters": [
{
"name": "url",
"in": "query",
"description": "TikTok short link",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TiktokResolvedShortlinkResponse"
}
}
},
"headers": {
"X-Tokens-Cost": {
"description": "The number of spent tokens",
"type": "number"
}
}
}
},
"x-stoplight": {
"id": "ttxvttywz14zh"
}
}
},
"/raw/tt/search/users/": {
"parameters": [],
"get": {
"operationId": "tt-search-users",
"summary": "TikTok Search Users",
"description": "\nReturns TikTok users' search result by the keyword. \nUp to 10 items on the page.\n\n### $ Paid request\n\nEvery successfully made request costs 0.002 tokens.\nSuccessful means we got some non-500 response from TikTok. For example, if you have passed an invalid keyword and TikTok returned empty results list, then it counts as one request. If there are some problems on our side, then you would not be charged.",
"tags": [
"TikTok Raw API"
],
"parameters": [
{
"name": "keyword",
"in": "query",
"description": "Keyword to search for.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TiktokSearchUsersResponse"
}
}
},
"headers": {
"X-Tokens-Cost": {
"description": "The number of spent tokens",
"type": "number"
}
}
}
},
"x-stoplight": {
"id": "r3grwqrspx3ll"
}
}
},
"/raw/tt/user/feed/": {
"parameters": [],
"get": {
"operationId": "tt-user-feed",
"summary": "TikTok User Feed",
"description": "\nReturns TikTok user feed information by his secUid, ID or username.\nUp to 30 posts on the page.\n\n### $ Paid request\n\nEvery successfully made request for a public account costs 0.002 tokens in case of secUid passed to url parameter and 0.006 tokens in case of user ID, username or link.\nRequests for restricted accounts are charged at 2× the public account rate.\nSuccessful means we got some non-500 response from TikTok. For example, if you have passed an invalid userId, but TikTok returned not found error, then it counts as one request. If the issue is on our side, you will not be charged.",
"tags": [
"TikTok Raw API"
],
"parameters": [
{
"name": "url",
"in": "query",
"description": "TikTok secUid, userId, username or link to user's profile page.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "after",
"in": "query",
"description": "Pass content of `maxCursor` field from the last response to get next page",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TiktokUserFeedResponse"
}
}
},
"headers": {
"X-Tokens-Cost": {
"description": "The number of spent tokens",
"type": "number"
}
}
}
},
"x-stoplight": {
"id": "16x0tzz0vry6p"
}
}
},
"/raw/tt/user/info/": {
"parameters": [],
"get": {
"operationId": "tt-user-info",
"summary": "TikTok User Info",
"description": "\nReturns TikTok user information by his ID, secUid or username.\n\n### $ Paid request\n\nEvery successfully made request for a public account costs 0.002 tokens.\nRequests for restricted accounts are charged at 2× the public account rate.\nSuccessful means we got some non-500 response from TikTok. For example, if you have passed an invalid userId, but TikTok returned not found error, then it counts as one request. If there are some problems on our side, then you would not be charged.",
"tags": [
"TikTok Raw API"
],
"parameters": [
{
"name": "url",
"in": "query",
"description": "TikTok username, userId, secUid or link to user's profile page.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TiktokUserInfoResponse"
}
}
},
"headers": {
"X-Tokens-Cost": {
"description": "The number of spent tokens",
"type": "number"
}
}
}
},
"x-stoplight": {
"id": "n06n3r4qgbodr"
}
}
},
"/raw/tt/user/media/": {
"parameters": [],
"get": {
"operationId": "tt-media",
"summary": "TikTok Media Info",
"description": "\nReturns TikTok media information by ID.\n\n### $ Paid request\n\nEvery successfully made request costs 0.002 tokens.\nSuccessful means we got some non-500 response from TikTok. For example, if you have passed an invalid postId, but TikTok returned not found error, then it counts as one request. If there are some problems on our side, then you would not be charged.",
"tags": [
"TikTok Raw API"
],
"parameters": [
{
"name": "url",
"in": "query",
"description": "TikTok postId or link to post's page.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TiktokMediaInfoResponse"
}
}
},
"headers": {
"X-Tokens-Cost": {
"description": "The number of spent tokens",
"type": "number"
}
}
}
},
"x-stoplight": {
"id": "xduj7lrh9uejn"
}
}
},
"/raw/tt/user/media/video/": {
"parameters": [],
"get": {
"operationId": "tt-media-video",
"summary": "TikTok Media Video Content",
"description": "\nReturns TikTok video content by media ID.\n\n### $ Paid request\n\nEvery successfully made request costs 0.01 tokens.\nSuccessful means we got some non-500 response from TikTok. For example, if you have passed an invalid postId, but TikTok returned not found error, then it counts as one request. If there are some problems on our side, then you would not be charged.",
"tags": [
"TikTok Raw API"
],
"parameters": [
{
"name": "url",
"in": "query",
"description": "TikTok postId or link to post's page.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "video_source",
"in": "query",
"description": "The source of video.",
"required": true,
"schema": {
"type": "string",
"enum": [
"playAddr",
"downloadAddr"
]
}
}
],
"responses": {
"200": {
"description": "Binary video data",
"headers": {
"Content-Type": {
"description": "The \"Content-Type\" header returned from social network",
"type": "string"
},
"X-Last-Modified": {
"description": "The \"Last-Modified\" header returned from social network",
"type": "string"
},
"X-Tokens-Cost": {
"description": "The number of spent tokens",
"type": "number"
}
}
},
"400": {
"description": "Any kind of error in JSON format"
}
},
"x-stoplight": {
"id": "9ivjgojvj1tpi"
}
}
},
"/raw/yt/channel/info/": {
"parameters": [],
"get": {
"operationId": "yt-channel-info",
"summary": "YouTube Channel Info",
"description": "\nReturns YouTube channel information by ID.\n\n### $ Paid request\n\nEvery successfully made request costs 0.001 tokens.\nSuccessful means we got some non-500 response from YouTube. For example, if you have passed an invalid username / channelId / link to channel's page, but YouTube returned not found error, then it counts as one request. If there are some problems on our side, then you would not be charged.",
"tags": [
"Youtube Raw API"
],
"parameters": [
{
"name": "url",
"in": "query",
"description": "YouTube channel ID either itself or within a link to channel page (like this one https://www.youtube.com/channel/UCxxxx).You can pass username (or the link with username) instead but it is less preferable way.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/YouTubeChannelInfoResponse"
}
}
},
"headers": {
"X-Tokens-Cost": {
"description": "The number of spent tokens",
"type": "number"
}
}
}
},
"x-stoplight": {
"id": "wobh520xn2jqh"
}
}
},
"/raw/yt/channel/playlists/": {
"parameters": [],
"get": {
"operationId": "yt-channel-playlists",
"summary": "YouTube Channel Playlists",
"description": "\nRetrieve a feed of playlists for a YouTube channel by URL or ID passed to `url`.\n\n### $ Paid request\n\nEvery successfully made request costs 0.001 tokens.\nSuccessful means we got some non-500 response from YouTube. For example, if you have passed an invalid video page URL or an incorrect channel ID, but YouTube returned a not found error, then it counts as one request. If there are some problems on our side, then you would not be charged.",
"tags": [
"Youtube Raw API"
],
"parameters": [
{
"name": "url",
"in": "query",
"description": "YouTube channel ID either itself or within a link to channel page (like this one https://www.youtube.com/channel/UCxxxx). You can pass username (or the link with username) instead but it is less preferable way.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "sorted_by",
"in": "query",
"description": "Sorting option: `dd` (date added) or `lad` (last video added).",
"required": false,
"schema": {
"type": "string",
"enum": [
"dd",
"lad"
],
"default": "dd"
}
},
{
"name": "after",
"in": "query",
"description": "Pass the content of the `cursor` field from the last response to get the next page.",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful response containing playlists related to the channel.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/YouTubePlaylistsResponse"
}
}
}
},
"400": {
"description": "Invalid input (e.g., missing identifier or invalid `sorted_by`)."
},
"500": {
"description": "Server error or issue with the request."
}
},
"x-stoplight": {
"id": "z659gib0f0ss6"
}
}
},
"/raw/yt/channel/videos/": {
"parameters": [],
"post": {
"operationId": "yt-channel-videos",
"summary": "YouTube Channel Videos",
"description": "\nReturns list of up to 30 YouTube videos on the channel under specific tab, with views and description preview.\n\n### $ Paid request\n\nEvery successfully made request costs 0.001 tokens.\nSuccessful means we got some non-500 response from YouTube. For example, if you have passed an invalid channelId / link to channel's page, but YouTube returned not found error, then it counts as one request. If there are some problems on our side, then you would not be charged.",
"tags": [
"Youtube Raw API"
],
"parameters": [
{
"name": "url",
"in": "query",
"description": "YouTube channelId or link to channel's page.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "videos_type",
"in": "query",
"description": "What tab to use: 'videos' for Videos tab (default), 'shorts' for Shorts tab, 'streams' for Live tab",
"required": false,
"schema": {
"type": "string",
"enum": [
"videos",
"shorts",
"streams"
],
"default": "videos"
}
},
{
"name": "sorted_by",
"in": "query",
"description": "Sorted by: 'dd' for Date Desc (default), 'p' for Popularity",
"required": false,
"schema": {
"type": "string",
"enum": [
"dd",
"p"
],
"default": "dd"
}
},
{
"name": "after",
"in": "query",
"description": "For pagination pass content of ```cursor``` field from the last response to get next page. For BC only, pass the one in the request body (see below).",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/YouTubeChannelVideosRequestBody"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/YouTubeChannelVideoListResponseData"
}
}
},
"headers": {
"X-Tokens-Cost": {
"description": "The number of spent tokens",
"type": "number"
}
}
}
},
"x-stoplight": {
"id": "lz6h647uof74b"
}
}
},
"/raw/yt/channel/videos/uploaded/": {
"parameters": [],
"get": {
"operationId": "yt-videos-from-uploaded-playlist",
"summary": "YouTube Uploaded Videos",
"description": "\nReturns list of 100 videos uploaded to the channel.\n\n### $ Paid request\n\nEvery successfully made request costs 0.001 tokens in case of channelId passed to `url` parameter and 0.002 tokens in case of username.\nSuccessful means we got some non-500 response from YouTube. For example, if you have passed an invalid username / channelId / link to channel's page, but YouTube returned not found error, then it counts as one request. If there are some problems on our side, then you would not be charged.",
"tags": [
"Youtube Raw API"
],
"parameters": [
{
"name": "url",
"in": "query",
"description": "YouTube username, channelId or link to channel's page.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "after",
"in": "query",
"description": "Pass content of ```cursor``` field from the last response to get next page",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlayListResponse"
}
}
},
"headers": {
"X-Tokens-Cost": {
"description": "The number of spent tokens",
"type": "number"
}
}
}
},
"x-stoplight": {
"id": "9jv4nptrwixlh"
}
}
},
"/raw/yt/hashtag/feed/": {
"parameters": [],
"post": {
"operationId": "yt-hashtag-feed",
"summary": "YouTube Hashtag Feed",
"description": "\nRetrieve a feed of videos associated with a specific hashtag. Supports pagination and allows filtering by tabs such as 'all' or 'shorts'.\n\nTo obtain the next page, pass the content of the `cursor` field to the `after` query parameter.\n\n### $ Paid request\n\nEvery successfully made request costs 0.001 tokens.\nA successful request means a non-500 response from YouTube. For example, if the hashtag is invalid, but YouTube returns a \"not found\" error, it still counts as a request. If there is an issue on our side, you will not be charged.",
"tags": [
"Youtube Raw API"
],
"parameters": [
{
"name": "url",
"in": "query",
"description": "YouTube hashtag url (e.g., https://www.youtube.com/hashtag/example)",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "after",
"in": "query",
"description": "Pass the content of the `cursor` field from the last response to get the next page",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "tab",
"in": "query",
"description": "Filter the feed by tab. Available options: `all` (default), `shorts`",
"required": false,
"schema": {
"type": "string",
"enum": [
"all",
"shorts"
],
"default": "all"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HashtagFeedRequestBody"
}
}
}
},
"responses": {
"200": {
"description": "Successful response containing videos related to the hashtag.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HashtagFeedResponse"
}
}
},
"headers": {
"X-Tokens-Cost": {
"description": "The number of spent tokens",
"type": "number"
}
}
},
"400": {
"description": "Invalid input (e.g., invalid `tab` or `after` parameter)."
},
"500": {
"description": "Server error or issue with the request."
}
},
"x-stoplight": {
"id": "5kejsrnat1or2"
}
}
},
"/raw/yt/hashtag/info/": {
"parameters": [],
"get": {
"operationId": "yt-hashtag-info",
"summary": "YouTube Hashtag Information",
"description": "\nReturns YouTube hashtag information by hashtag.\n\n### $ Paid request\n\nEvery successfully made request costs 0.001 tokens.\nSuccessful means we got some non-500 response from YouTube. For example, if you have passed an invalid hashtag / link to hashtag's page, but YouTube returned not found error, then it counts as one request. If there are some problems on our side, then you would not be charged.",
"tags": [
"Youtube Raw API"
],
"parameters": [
{
"name": "url",
"in": "query",
"description": "YouTube hashtag (like #earth) or link to hashtag's page like 'https://www.youtube.com/hashtag/earth'.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/YouTubeHashtagInfoResponse"
}
}
},
"headers": {
"X-Tokens-Cost": {
"description": "The number of spent tokens",
"type": "number"
}
}
}
},
"x-stoplight": {
"id": "ziyuwztbhdpwc"
}
}
},
"/raw/yt/playlist/": {
"parameters": [],
"get": {
"operationId": "yt-playlist-videos",
"summary": "YouTube Playlist Videos",
"description": "\nReturns list of 100 YouTube videos from any playlist by ID passed to `url`.\n\n### $ Paid request\n\nEvery successfully made request costs 0.001 tokens.\nSuccessful means we got some non-500 response from YouTube. For example, if you have passed an invalid playlistId, but YouTube returned not found error, then it counts as one request. If there are some problems on our side, then you would not be charged.",
"tags": [
"Youtube Raw API"
],
"parameters": [
{
"name": "url",
"in": "query",
"description": "YouTube playlistId.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "after",
"in": "query",
"description": "Pass content of ```cursor``` field from the last response to get next page. Only required for pagination, not for the first page.",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlayListResponse"
}
}
},
"headers": {
"X-Tokens-Cost": {
"description": "The number of spent tokens",
"type": "number"
}
}
}
},
"x-stoplight": {
"id": "qf8gyyjgpt9ut"
}
}
},
"/raw/yt/video/": {
"parameters": [],
"get": {
"operationId": "yt-video-info",
"summary": "YouTube Video Info",
"description": "\nReturns YouTube video information by URL or video ID passed to `url`.\n\n### $ Paid request\n\nEvery successfully made request costs 0.005 tokens.\nSuccessful means we got some non-500 response from YouTube. For example, if you have passed an invalid video page URL or an incorrect video ID, but YouTube returned a not found error, then it counts as one request. If there are some problems on our side, then you would not be charged.",
"tags": [
"Youtube Raw API"
],
"parameters": [
{
"name": "url",
"in": "query",
"description": "YouTube video page URL (e.g., https://www.youtube.com/watch?v=xxxx) or video ID (e.g., xxxx)",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/YouTubeVideoInfoResponse"
}
}
},
"headers": {
"X-Tokens-Cost": {
"description": "The number of spent tokens",
"type": "number"
}
}
}
},
"x-stoplight": {
"id": "mgatse12txjq1"
}
}
},
"/raw/yt/video/comments/": {
"parameters": [],
"get": {
"operationId": "yt-video-comments",
"summary": "YouTube Video Comments",
"description": "\nGet comments for YouTube video with pagination. We can't guarantee the order of the comments and how much comments returned per page, so don't rely on it.\nTo get the next page pass content of ```cursor``` to the ```after``` query parameter.\n\nTo obtain the first comments page use the ```cursor``` from [Video Info endpoint](#operation/yt-video-info)\n\n### $ Paid request\n\nEvery successfully made request costs 0.001 tokens.\nSuccessful means we got some non-500 response from YouTube. For example, if you have passed an invalid video page url, but YouTube returned not found error, then it counts as one request. If there are some problems on our side, then you would not be charged.",
"tags": [
"Youtube Raw API"
],
"parameters": [
{
"name": "url",
"in": "query",
"description": "YouTube video page url (like this one https://www.youtube.com/watch?v=xxxx)",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "after",
"in": "query",
"description": "Pass content of ```cursor``` field from the last response to get next page. To obtain the first comments page use the cursor from Video Info endpoint.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/YouTubeVideoCommentsResponse"
}
}
},
"headers": {
"X-Tokens-Cost": {
"description": "The number of spent tokens",
"type": "number"
}
}
}
},
"x-stoplight": {
"id": "k6u6sdsuysmps"
}
}
},
"/raw/yt/video/comments/replies/": {
"parameters": [],
"get": {
"operationId": "yt-video-comments-replies",
"summary": "YouTube Video Comment Replies",
"description": "\nGet replies to the specific comment of the video with pagination. We can't guarantee the order of the replies and how much replies returned per page, so don't rely on it.\nTo get the next page pass content of ```cursor``` to the ```after``` query parameter.\n\nTo obtain the first replies page use the ```replies_cursor``` from [Video Comments endpoint](#operation/yt-video-comments)\n\n### $ Paid request\n\nEvery successfully made request costs 0.001 tokens.\nSuccessful means we got some non-500 response from YouTube. For example, if you have passed an invalid video page url, but YouTube returned not found error, then it counts as one request. If there are some problems on our side, then you would not be charged.",
"tags": [
"Youtube Raw API"
],
"parameters": [
{
"name": "url",
"in": "query",
"description": "YouTube video page url (like this one https://www.youtube.com/watch?v=xxxx)",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "after",
"in": "query",
"description": "Pass content of ```cursor``` field from the last response to get next page. To obtain the first comments page use the cursor from Video Info endpoint.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/YouTubeVideoCommentRepliesResponse"
}
}
},
"headers": {
"X-Tokens-Cost": {
"description": "The number of spent tokens",
"type": "number"
}
}
}
},
"x-stoplight": {
"id": "etzn4vffjkdib"
}
}
},
"/reports/audience_overlap/": {
"parameters": [],
"post": {
"operationId": "ad-reports-overlap-ad-report",
"summary": "Overlap Audience Report",
"description": "Creates a new audience data report for the shared audience among multiple influencers.\n\nWe strongly recommend using an influencer's user ID rather than username (or link) wherever possible, as Influencers often change their usernames. User ID, on the other hand, is a constant for a given user, so it would help to avoid unexpected behaviour on report update.\n\n### $ Paid request\nEach request costs 1 token * number of users provided.\n\n`auto_subscribe` is available only if you have an active Audience Data subscription with remaining quota.\n",
"tags": [
"Audience Data"
],
"parameters": [
{
"name": "platform",
"in": "query",
"description": "",
"required": true,
"schema": {
"type": "string",
"enum": [
"instagram"
],
"default": "instagram"
}
},
{
"name": "urls",
"in": "query",
"description": "Comma separated list of usernames or user ids. Provide it here or in the POST body",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "auto_subscribe",
"in": "query",
"description": "Automatically subscribes users from the ```urls``` parameter for updates. This has no impact on request cost. Available only if you have an active Audience Data subscription with sufficient quota.",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "calculation_method",
"in": "query",
"description": "If provided, specifies the method used to calculate values of average metrics (like average likers, comments and so on).\n\nAvailable options:\n- `average` : Use arithmetic mean.\n- `median` : Use the median value.\n\nIf not provided, the user's account-level setting is used.",
"required": false,
"schema": {
"type": "string",
"enum": [
"median",
"average"
]
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OverlapReport"
}
}
},
"headers": {
"X-Tokens-Cost": {
"description": "The number of spent tokens",
"type": "number"
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OverlapError"
}
}
}
}
},
"x-stoplight": {
"id": "enz1j34j32zkf"
}
}
},
"/reports/new/": {
"parameters": [],
"post": {
"operationId": "new-report",
"summary": "New report",
"description": "Creates new audience data report.\n\nIt is also possible to call this endpoint with *GET* method instead *POST* to simplify testing.\n\nWe strongly recommend to use influencer's user_id rather than username (or link) wherever possible, \nas Influencers often change their usernames. User ID, on the other hand, is a constant for a given user, \nso it would help to avoid unexpected behaviour on report update.\n\nYou can fetch this report later by report_info.report_id in different formats (JSON, PDF) using [fetch report endpoint](#operation/fetch-ad-report).\nYour report will be eliminated after 60 days of storage.\n\n### $ Paid request\n\nIf `dry_run` query parameter is set to `true` then nothing is charged in any cases.\n\nIf there is no Audience Data Updates subscription on your account, then this request cost 1 token for each report returned.\nWe charge only for successful requests and do not if there is no Audience Data report returned.\n\nIf you have active Monthly Updates Subscription and free quota in it, then it costs 1 token first time you call this endpoint and then\nall chaining requests for the same influencer are free until the monthly subscription is active. The `subscribe` query parameter defaults\nto `1` whenever you have an active subscription.\n\nYou can pass ```subscribe=0``` to not subscribe for the updates for this influencer.\nThe request cost 1 token if you have not been subscribed to it before.\n\nYou can pass ```subscribe=1``` to not spend tokens when there is no quota left in the subscription. You will receive `no_quota_remaining` error in this case instead.\n\nOnce you stopped Monthly Updates subscription and re-enabled it, you spend 1 token per influencer again to subscribe for updates.\n",
"tags": [
"Audience Data"
],
"parameters": [
{
"name": "url",
"in": "query",
"description": "Username, userId or link to user's profile page.",
"schema": {
"type": "string"
}
},
{
"name": "subscribe",
"in": "query",
"description": "Subscribe to updates of requested user data. Applicable only if Audience Data Monthly Updates Subscription is active and have free quota. In other cases this endpoint return 400 response BEFORE charging token. It is ignored if user has been already in the list of monthly updates subscriptions",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"name": "ignore_removed",
"in": "query",
"description": "If you receive account_removed error we probably have old audience data for that account. To get it set this parameter to true",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "ignore_outdated",
"in": "query",
"description": "If you receive retry_later error we probably have an outdated information for that account. To get the report anyway set this parameter to true",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "ignore_empty_audience",
"in": "query",
"description": "If you want to ignore empty audience set this argument.",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "dry_run",
"in": "query",
"description": "Set to \"true\" or \"1\" to check whether the report can be built or not",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "calculation_method",
"in": "query",
"description": "If provided, specifies the method used to calculate values of average metrics (like average likers, comments and so on).\n\nAvailable options:\n- `average` : Use arithmetic mean.\n- `median` : Use the median value.\n\nIf not provided, the user's account-level setting is used.",
"required": false,
"schema": {
"type": "string",
"enum": [
"median",
"average"
]
}
},
{
"name": "platform",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "string",
"enum": [
"instagram",
"tiktok",
"youtube",
"douyin"
],
"default": "instagram"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SamplingRequest"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SamplingReport"
}
}
},
"headers": {
"X-Tokens-Cost": {
"description": "The number of spent tokens",
"type": "number"
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SamplingError"
}
}
}
},
"500": {
"description": ""
}
},
"x-stoplight": {
"id": "141bk6i0dabep"
}
}
},
"/reports/overlap/": {
"parameters": [],
"post": {
"operationId": "ad-reports-overlap-post",
"summary": "Audience overlap",
"description": "Check for audience (follower) overlap among several users. \n\nAn endpoint has no limits on the total number of accounts to analyze. The only limit it has is processing time, which is limited to one minute. It depends on the total number of followers, so asking to overlap many large accounts may result in a timeout. Practically, it works well on 100 random bloggers. However, once you receive a timeout, you can retry the same request in 10-15 minutes. It may succeed after repeated attempts due to internal optimizations.\n\n### $ Paid request\nIf there is no Overlap subscription on your account then this request cost 1 token for each report returned.\nWe charge only for successful requests and do not if there was no report returned.\n\nIf you have active Audience Data + Overlap subscription then overlap calculation is only allowed for users under Audience Data Updates subscription.\nIf they are not then subscribe them first using [new report endpoint](#operation/new-report) or use ```auto_subscribe=true``` option.\nIt cost the same amount of tokens as amount of users out of subscription in the request.\n",
"tags": [
"Audience Data"
],
"parameters": [
{
"name": "platform",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "string",
"enum": [
"instagram",
"youtube",
"tiktok"
],
"default": "instagram"
}
},
{
"name": "urls",
"in": "query",
"description": "Comma separated list of usernames or user ids. Provide it here or in the POST body",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "auto_subscribe",
"in": "query",
"description": "Subscribe for updates for users from ```urls``` parameter automatically. Attention - we charge 1 token per every new user in subscription according to [Audience Data pricing](#operation/new-report). Applicable only with active AD Updates subscription.",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "fmt",
"in": "query",
"description": "Format of response",
"required": false,
"schema": {
"type": "string",
"enum": [
"csv",
"json"
],
"default": "json"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OverlapReport"
}
}
},
"headers": {
"X-Tokens-Cost": {
"description": "The number of spent tokens",
"type": "number"
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OverlapError"
}
}
}
}
},
"x-stoplight": {
"id": "plsqnny2jrji2"
}
}
},
"/reports/overlap_matrix/": {
"parameters": [],
"post": {
"operationId": "overlap-matrix",
"summary": "Overlap Matrix",
"description": "\nThe Overlap Matrix allows you to compare multiple influencers and measure how much their audiences overlap. The API returns a matrix showing the shared-follower ratio between each pair of influencers in the request.\n\n### $ Paid request\n\nThe cost of each request is calculated as: (1 token × number_of_users) − 1. For example, a request with 3 users costs 2 tokens, and with 4 users — 3 tokens.\n\n`auto_subscribe` is available only if you have an active Audience Data subscription with remaining quota.\n\n",
"tags": [
"Audience Data"
],
"parameters": [
{
"name": "platform",
"in": "query",
"description": "",
"required": true,
"schema": {
"type": "string",
"enum": [
"instagram",
"tiktok",
"youtube"
],
"default": "instagram"
}
},
{
"name": "urls",
"in": "query",
"description": "Comma separated list of usernames or user ids. Provide it here or in the POST body",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "auto_subscribe",
"in": "query",
"description": "Automatically subscribes users from the ```urls``` parameter for updates. This has no impact on request cost. Available only if you have an active Audience Data subscription with sufficient quota.",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OverlapMatrixReport"
}
}
},
"headers": {
"X-Tokens-Cost": {
"description": "The number of spent tokens",
"type": "number"
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OverlapError"
}
}
}
}
},
"x-stoplight": {
"id": "3msike4pqbz8g"
}
}
},
"/reports/{report_id}/": {
"parameters": [
{
"name": "report_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"operationId": "fetch-ad-report",
"summary": "Fetch report file",
"description": "Fetch previously generated report in JSON or PDF format.\n\nWe keep old reports for 30 days.\nis_stored flag in [List AD reports endpoint](#operation/list-ad-reports) is indicator of is it can be retrieved or not.\nIf report has been removed than this endpoint return 404 error (not_found).\n",
"tags": [
"Audience Data"
],
"parameters": [
{
"name": "report_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "fmt",
"in": "query",
"description": "",
"required": true,
"schema": {
"type": "string",
"enum": [
"pdf",
"json"
]
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SamplingReport"
}
}
}
}
},
"x-stoplight": {
"id": "wi2m8rtelsli7"
}
}
},
"/search/newv1/": {
"parameters": [],
"post": {
"operationId": "search-for-influencers",
"summary": "Search for influencers",
"description": "Search for influencers matching certain filters.\n\nWhile integrating, it's much easier to look at the Web interface and inspect search requests made in your web browser.\nRequests format is the same - you can inspect request in the web browser and send it to Search API.\n\n### $ Paid request (tokens)\nIn case query parameter `auto_unhide` is set to `1` this request may charge tokens for every hidden search result according [Unlock influencers operation](#operation/unhide-influencers) pricing.\nThe response contains extra fields: `cost` - how much tokens deducted from your balance and `shown_accounts` - list of unlocked accounts.\n\nWithout this parameter, you must manually call Unlock operation for hidden results.\n\n### $ Paid request (subscription)\nHaving a subscription unlocks all influencers matching the subscription criteria.\nThe rest are hidden and must be unlocked (for tokens) to be shown up.\n\nUsing the subscription, you can make no more than 5,000 search requests per month.\nAsk your manager if you want to include higher requests volume into the subscription.\n",
"tags": [
"Search"
],
"parameters": [
{
"name": "auto_unhide",
"in": "query",
"description": "Automatically do paid unlock operation for all hidden search results.",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"name": "extras",
"in": "query",
"description": "Comma-separated list of additional fields to include in the response. Currently supported values: `description`, `report_id`. For example, passing `description,report_id` will include the `user_profile.description` field and report IDs in the API response.",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "calculation_method",
"in": "query",
"description": "If provided, specifies the method used to calculate values of average metrics (like average likers, comments and so on).\n\nAvailable options:\n- `average` : Use arithmetic mean.\n- `median` : Use the median value.\n\nIf not provided, the user's account-level setting is used.",
"required": false,
"schema": {
"type": "string",
"enum": [
"median",
"average"
]
}
},
{
"name": "platform",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "string",
"enum": [
"instagram",
"tiktok",
"youtube"
],
"default": "instagram"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SearchRequest"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SearchResult"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SearchResultError"
}
}
}
}
},
"x-stoplight": {
"id": "geogkk0rup9n5"
}
}
},
"/search/unhide/": {
"parameters": [],
"post": {
"operationId": "unhide-influencers",
"summary": "Unlock influencers",
"description": "Show information for influencers hidden in search results.\n\nThere are two cases when influencers hidden in search results:\n1. You don't have a subscription for Influencer Identification tool.\n2. An influencer is out of your subscription. For example, if you have a subscription for all having followers more than 5000, then influencer with 3000 followers would be hidden in search results.\n\nIf you have a subscription for all influencers having 1k+ followers, then this method is not applicable for you - all results not hidden in search results.\n\n### $ Paid request\nUnlock of every valid search result ID for influencers previously not unlocked cost 0.02 tokens.\nYou will see these influencers for free in all search results and data exports without contact details under any filters within the next 30 days. \n",
"tags": [
"Search"
],
"parameters": [
{
"name": "platform",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "string",
"enum": [
"instagram",
"tiktok",
"youtube"
],
"default": "instagram"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnhideRequest"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnhideResponse"
}
}
},
"headers": {
"X-Tokens-Cost": {
"description": "The number of spent tokens",
"type": "number"
}
}
}
},
"x-stoplight": {
"id": "ajys08rut7pof"
}
}
}
},
"components": {
"securitySchemes": {
"header": {
"type": "apiKey",
"in": "header",
"name": "X-Api-Key"
}
},
"schemas": {
"AccountInfoSubscriptionBase": {
"required": [
"type",
"platform",
"is_active",
"options",
"state"
],
"type": "object",
"properties": {
"type": {
"title": "Type",
"type": "string",
"minLength": 1
},
"platform": {
"title": "Platform",
"type": "string",
"enum": [
"instagram",
"tiktok",
"youtube"
]
},
"end": {
"title": "End",
"type": "string",
"format": "date-time"
},
"next_quota_at": {
"title": "Next quota at",
"type": "string",
"format": "date-time"
},
"last_quota_at": {
"title": "Last quota at",
"type": "string",
"format": "date-time"
},
"is_active": {
"title": "Is active",
"type": "boolean"
},
"options": {
"title": "Options",
"type": "object",
"additionalProperties": {
"type": "string",
"nullable": true
}
},
"state": {
"title": "State",
"type": "object",
"additionalProperties": {
"type": "string",
"nullable": true
}
}
},
"x-stoplight": {
"id": "6e18ooorl8mde"
}
},
"AccountInfoUser": {
"required": [
"fullname",
"email"
],
"type": "object",
"properties": {
"fullname": {
"title": "Fullname",
"type": "string",
"minLength": 1
},
"email": {
"title": "Email",
"type": "string",
"minLength": 1
},
"email_billing": {
"title": "Email billing",
"type": "string",
"format": "email",
"minLength": 1
}
},
"x-stoplight": {
"id": "812xg5iecdhzr"
}
},
"AccountInfoDailySpending": {
"required": [
"tokens"
],
"type": "object",
"properties": {
"tokens": {
"title": "Tokens",
"type": "number"
}
},
"x-stoplight": {
"id": "rbnz79vmx9m6h"
}
},
"AccountInfo": {
"required": [
"tokens",
"subscriptions",
"user",
"daily_spending"
],
"type": "object",
"properties": {
"tokens": {
"title": "Tokens",
"description": "Number of tokens left in your account. Deprecated, use subscriptions[type=\"tokens\"].state.tokens instead",
"type": "number"
},
"subscriptions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AccountInfoSubscriptionBase"
}
},
"user": {
"$ref": "#/components/schemas/AccountInfoUser"
},
"daily_spending": {
"$ref": "#/components/schemas/AccountInfoDailySpending"
}
},
"x-stoplight": {
"id": "y6z7zj3s6724p"
}
},
"Categories": {
"required": [
"success",
"data"
],
"type": "object",
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"data": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
}
},
"x-stoplight": {
"id": "85gohofjvzc7t"
}
},
"InterestDetail": {
"required": [
"id",
"name",
"count",
"deprecated"
],
"type": "object",
"properties": {
"id": {
"title": "Id",
"type": "integer"
},
"name": {
"title": "Name",
"type": "string",
"minLength": 1
},
"count": {
"title": "Count",
"type": "integer"
},
"deprecated": {
"title": "Deprecated",
"type": "boolean"
}
},
"x-stoplight": {
"id": "pb9c5xfh6x0zj"
}
},
"Id": {
"required": [
"id"
],
"type": "object",
"properties": {
"id": {
"title": "Id",
"type": "integer"
}
},
"x-stoplight": {
"id": "3lw3w00xftqct"
}
},
"BrandsDetail": {
"required": [
"id",
"name",
"count",
"deprecated",
"interest"
],
"type": "object",
"properties": {
"id": {
"title": "Id",
"type": "integer"
},
"name": {
"title": "Name",
"type": "string",
"minLength": 1
},
"count": {
"title": "Count",
"type": "integer"
},
"deprecated": {
"title": "Deprecated",
"type": "boolean"
},
"interest": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Id"
}
}
},
"x-stoplight": {
"id": "uod8htbqaisdi"
}
},
"InterestsData": {
"required": [
"interests",
"brands"
],
"type": "object",
"properties": {
"interests": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InterestDetail"
}
},
"brands": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BrandsDetail"
}
}
},
"x-stoplight": {
"id": "tuz1nmjvf42or"
}
},
"Interests": {
"required": [
"success",
"data"
],
"type": "object",
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"data": {
"$ref": "#/components/schemas/InterestsData"
}
},
"x-stoplight": {
"id": "9ig8kyctlp078"
}
},
"LangDetail": {
"required": [
"code",
"count",
"name"
],
"type": "object",
"properties": {
"code": {
"title": "Code",
"type": "string",
"minLength": 1
},
"count": {
"title": "Count",
"description": "Frequency of influencers related to this language",
"type": "integer"
},
"name": {
"title": "Name",
"type": "string",
"minLength": 1
}
},
"x-stoplight": {
"id": "16aw7vytv47pt"
}
},
"LangList": {
"required": [
"success",
"data"
],
"type": "object",
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LangDetail"
}
}
},
"x-stoplight": {
"id": "5e2qohqhpz41k"
}
},
"TopicTensorData": {
"required": [
"tag",
"distance",
"freq",
"tag_cnt"
],
"type": "object",
"properties": {
"tag": {
"title": "Tag",
"type": "string",
"minLength": 1
},
"distance": {
"title": "Distance",
"description": "The lesser is number - the closer this tag is to queried topic",
"type": "number"
},
"freq": {
"title": "Freq",
"description": "The frequency of the tag on social media network - a bigger number means more frequency",
"type": "number"
},
"tag_cnt": {
"title": "Tag cnt",
"type": "number"
}
},
"x-stoplight": {
"id": "32yoycglbbin6"
}
},
"TopicTensor": {
"required": [
"success",
"data"
],
"type": "object",
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TopicTensorData"
}
}
},
"x-stoplight": {
"id": "c3eu8d3dtzr8x"
}
},
"TopicTag": {
"required": [
"tag",
"value"
],
"type": "object",
"properties": {
"tag": {
"title": "Tag",
"type": "string",
"minLength": 1
},
"value": {
"title": "Value",
"type": "string",
"minLength": 1
}
},
"x-stoplight": {
"id": "4wgiygcoxdmr5"
}
},
"ResponseTopicTag": {
"required": [
"success",
"data"
],
"type": "object",
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TopicTag"
}
}
},
"x-stoplight": {
"id": "t3cxg0cz1cxbg"
}
},
"UserDetail": {
"required": [
"user_id",
"username",
"fullname",
"picture",
"followers",
"is_verified"
],
"type": "object",
"properties": {
"user_id": {
"title": "User id",
"type": "string",
"minLength": 1
},
"username": {
"title": "Username",
"type": "string",
"minLength": 1
},
"fullname": {
"title": "Fullname",
"type": "string",
"minLength": 1
},
"custom_name": {
"title": "Custom name",
"type": "string",
"minLength": 1
},
"handle": {
"title": "Handle",
"type": "string",
"minLength": 1
},
"picture": {
"title": "Picture",
"type": "string",
"format": "uri",
"minLength": 1
},
"followers": {
"title": "Followers",
"type": "integer"
},
"is_verified": {
"title": "Is verified",
"type": "boolean"
}
},
"x-stoplight": {
"id": "aoj4apsns6khs"
}
},
"UserList": {
"required": [
"success",
"data"
],
"type": "object",
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserDetail"
}
}
},
"x-stoplight": {
"id": "yv1tuzwh450nh"
}
},
"DataExport": {
"required": [
"export_id",
"platform",
"export_type",
"fail_reason"
],
"type": "object",
"properties": {
"export_id": {
"title": "Export id",
"type": "string",
"minLength": 1
},
"platform": {
"title": "Platform",
"type": "string",
"minLength": 1
},
"export_type": {
"title": "Export type",
"type": "string",
"enum": [
"FULL",
"SHORT"
]
},
"filter": {
"title": "Filter",
"type": "string",
"readOnly": true
},
"limit": {
"title": "Limit",
"type": "integer"
},
"added_at": {
"title": "Added at",
"type": "string",
"format": "date-time",
"readOnly": true
},
"estimated_results_count": {
"title": "Estimated results count",
"type": "integer"
},
"estimated_cost": {
"title": "Estimated cost",
"type": "number",
"readOnly": true,
"nullable": true
},
"done_at": {
"title": "Done at",
"type": "string",
"format": "date-time",
"readOnly": true
},
"results_count": {
"title": "Results count",
"type": "integer"
},
"cost": {
"title": "Cost",
"type": "number",
"readOnly": true,
"nullable": true
},
"is_failed": {
"title": "Is failed",
"type": "boolean",
"nullable": true
},
"fail_reason": {
"title": "Fail reason",
"type": "string",
"minLength": 1
},
"send_email": {
"title": "Send email",
"type": "boolean"
},
"calculation_method": {
"title": "Calculation method",
"type": "string",
"enum": [
"median",
"average"
],
"readOnly": true,
"nullable": true
}
},
"x-stoplight": {
"id": "bn50e8w2un9g4"
}
},
"PaginatedExports": {
"required": [
"results"
],
"type": "object",
"properties": {
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataExport"
}
}
},
"x-stoplight": {
"id": "rmj9l95d4dfaq"
}
},
"Interest": {
"required": [
"id",
"name"
],
"type": "object",
"properties": {
"id": {
"title": "Id",
"type": "integer"
},
"name": {
"title": "Name",
"type": "string",
"minLength": 1
}
},
"x-stoplight": {
"id": "hbvm4t2mnorse"
}
},
"Brand": {
"description": "We need some time to fix it. If you have any questions or need further assistance, please feel free to contact us. \n We appreciate your patience and understanding.\n
![](\"/assets/images/social-network/sn_instagram.svg\"/ "\\"Available")
",
"required": [
"id",
"name"
],
"type": "object",
"properties": {
"id": {
"title": "Id",
"type": "integer"
},
"name": {
"title": "Name",
"type": "string",
"minLength": 1
},
"interest": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Interest"
}
}
},
"x-stoplight": {
"id": "cd558cn8z0l8q"
}
},
"Contact": {
"required": [
"type",
"value"
],
"type": "object",
"properties": {
"type": {
"title": "Type",
"type": "string",
"enum": [
"bbm",
"email",
"facebook",
"instagram",
"itunes",
"kakao",
"kik",
"lineid",
"linktree",
"phone",
"pinterest",
"sarahah",
"sayat",
"skype",
"snapchat",
"telegram",
"threads",
"tiktok",
"tumblr",
"twitchtv",
"twitter",
"viber",
"vk",
"wechat",
"weibo",
"whatsapp",
"youtube"
]
},
"value": {
"title": "Value",
"type": "string",
"minLength": 1
},
"formatted_value": {
"title": "Formatted value",
"description": "Ready to use URL to contact. For example, link to youtube channel.",
"type": "string",
"minLength": 1
},
"checked": {
"title": "Checked",
"description": "Whether it's a mutual contact (i.e. the social network account by this URL has link to the account you've requested AD on)",
"type": "boolean"
},
"might_be_agency": {
"title": "Might be agency",
"description": "Only applicable to email-type contacts. Marked as true when the same email is found across more than 10 creators.",
"type": "boolean"
}
},
"x-stoplight": {
"id": "m53h9qkm5d3v9"
}
},
"Coords": {
"type": "object",
"properties": {
"lat": {
"title": "Lat",
"type": "number"
},
"lon": {
"title": "Lon",
"type": "number"
}
},
"x-stoplight": {
"id": "0vx2qcrdzb1a7"
}
},
"GeoCity": {
"description": "Instagram only",
"required": [
"id",
"name"
],
"type": "object",
"properties": {
"id": {
"title": "Id",
"type": "integer"
},
"name": {
"title": "Name",
"type": "string",
"minLength": 1
},
"coords": {
"$ref": "#/components/schemas/Coords"
}
},
"x-stoplight": {
"id": "sw6zt8t0vprxm"
}
},
"GeoCountry": {
"required": [
"id",
"name",
"code"
],
"type": "object",
"properties": {
"id": {
"title": "Id",
"type": "integer"
},
"name": {
"title": "Name",
"type": "string",
"minLength": 1
},
"coords": {
"$ref": "#/components/schemas/Coords"
},
"code": {
"title": "Code",
"type": "string",
"minLength": 1
}
},
"x-stoplight": {
"id": "2s0v8n0g49q4y"
}
},
"SubdivisionItem": {
"type": "object",
"properties": {
"id": {
"title": "Id",
"type": "integer"
},
"name": {
"title": "Name",
"type": "string",
"minLength": 1
},
"weight": {
"title": "Weight",
"type": "number"
}
},
"x-stoplight": {
"id": "f40yir58fei35"
}
},
"Subdivision": {
"description": "Instagram only",
"type": "object",
"properties": {
"id": {
"title": "Id",
"type": "integer"
},
"name": {
"title": "Name",
"type": "string",
"minLength": 1
},
"code": {
"title": "Code",
"type": "string",
"minLength": 1
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SubdivisionItem"
}
}
},
"x-stoplight": {
"id": "7oqn442659mt8"
}
},
"GeoState": {
"description": "Deprecated",
"required": [
"id",
"name"
],
"type": "object",
"properties": {
"id": {
"title": "Id",
"type": "integer"
},
"name": {
"title": "Name",
"type": "string",
"minLength": 1
},
"coords": {
"$ref": "#/components/schemas/Coords"
}
},
"x-stoplight": {
"id": "6opwpr4o5pk1y"
}
},
"Geo": {
"required": [
"country"
],
"type": "object",
"properties": {
"city": {
"$ref": "#/components/schemas/GeoCity"
},
"country": {
"$ref": "#/components/schemas/GeoCountry"
},
"subdivision": {
"$ref": "#/components/schemas/Subdivision"
},
"state": {
"$ref": "#/components/schemas/GeoState"
}
},
"x-stoplight": {
"id": "rodp21p3bhkv0"
}
},
"Language": {
"required": [
"code",
"name"
],
"type": "object",
"properties": {
"code": {
"title": "Code",
"type": "string",
"enum": [
"af",
"als",
"am",
"an",
"ar",
"arz",
"as",
"ast",
"av",
"az",
"azb",
"ba",
"bar",
"bcl",
"be",
"bg",
"bh",
"bn",
"bo",
"bpy",
"br",
"bs",
"bxr",
"ca",
"cbk",
"ce",
"ceb",
"ckb",
"co",
"cs",
"cv",
"cy",
"da",
"de",
"diq",
"dsb",
"dty",
"dv",
"dz",
"el",
"eml",
"en",
"eo",
"es",
"et",
"eu",
"fa",
"fi",
"fo",
"fr",
"frr",
"fy",
"ga",
"gd",
"gl",
"gn",
"gom",
"gu",
"gv",
"he",
"hi",
"hif",
"hr",
"hsb",
"ht",
"hu",
"hy",
"ia",
"id",
"ie",
"ilo",
"in",
"io",
"is",
"it",
"ja",
"jbo",
"jv",
"ka",
"kk",
"km",
"kn",
"ko",
"krc",
"ku",
"kv",
"kw",
"ky",
"la",
"lb",
"lez",
"li",
"lmo",
"lo",
"lrc",
"lt",
"lv",
"mai",
"mg",
"mhr",
"min",
"mk",
"ml",
"mn",
"mr",
"mrj",
"ms",
"mt",
"mwl",
"my",
"myv",
"mzn",
"nah",
"nap",
"nb",
"nds",
"ne",
"new",
"nl",
"nn",
"no",
"oc",
"or",
"os",
"pa",
"pam",
"pfl",
"pl",
"pms",
"pnb",
"ps",
"pt",
"qu",
"rm",
"ro",
"ru",
"rue",
"rw",
"sa",
"sah",
"sc",
"scn",
"sco",
"sd",
"se",
"sh",
"si",
"sk",
"sl",
"so",
"sq",
"sr",
"su",
"sv",
"sw",
"ta",
"te",
"tg",
"th",
"tk",
"tl",
"tr",
"tt",
"tyv",
"ug",
"uk",
"ur",
"uz",
"vec",
"vep",
"vi",
"vls",
"vo",
"wa",
"war",
"wuu",
"xal",
"xh",
"xmf",
"yi",
"yo",
"yue",
"zh",
"zh-Hant",
"zu"
]
},
"name": {
"title": "Name",
"description": "Name of the language in English",
"type": "string",
"minLength": 1
}
},
"x-stoplight": {
"id": "hvjdtpnmw4l4b"
}
},
"BaseUserProfile": {
"required": [
"engagement_rate",
"engagements",
"followers",
"url",
"user_id"
],
"type": "object",
"properties": {
"account_type": {
"title": "Account type",
"description": "",
"type": "integer",
"enum": [
1,
2,
3
]
},
"age_group": {
"title": "Age group",
"type": "string",
"minLength": 1
},
"avg_likes": {
"title": "Avg likes",
"type": "integer"
},
"avg_views": {
"title": "Avg views",
"description": "![](\"/assets/images/social-network/sn_youtube.svg\"/ "\\"Available")
![](\"/assets/images/social-network/sn_tiktok.svg\"/ "\\"Available")
",
"type": "integer"
},
"brand_affinity": {
"description": "",
"type": "array",
"items": {
"$ref": "#/components/schemas/Brand"
}
},
"contacts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Contact"
}
},
"custom_name": {
"title": "Custom name",
"description": "",
"type": "string",
"minLength": 1
},
"description": {
"title": "Description",
"type": "string"
},
"engagement_rate": {
"title": "Engagement rate",
"type": "number"
},
"engagements": {
"title": "Engagements",
"type": "integer"
},
"followers": {
"title": "Followers",
"type": "integer"
},
"fullname": {
"title": "Fullname",
"type": "string",
"minLength": 1
},
"gender": {
"title": "Gender",
"type": "string",
"enum": [
"MALE",
"FEMALE"
]
},
"geo": {
"$ref": "#/components/schemas/Geo"
},
"handle": {
"title": "Handle",
"description": "",
"type": "string",
"minLength": 1
},
"interests": {
"description": "",
"type": "array",
"items": {
"$ref": "#/components/schemas/Interest"
}
},
"is_verified": {
"title": "Is verified",
"type": "boolean"
},
"language": {
"$ref": "#/components/schemas/Language"
},
"picture": {
"title": "Picture",
"type": "string",
"minLength": 1
},
"sec_uid": {
"title": "Sec uid",
"description": "",
"type": "string",
"minLength": 1
},
"url": {
"title": "Url",
"type": "string",
"minLength": 1
},
"user_id": {
"title": "User id",
"type": "string",
"minLength": 1
},
"username": {
"title": "Username",
"type": "string",
"minLength": 1
}
},
"x-stoplight": {
"id": "zhfuvy3yhpnzk"
}
},
"ContactExport": {
"required": [
"success",
"user_profile"
],
"type": "object",
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"user_profile": {
"$ref": "#/components/schemas/BaseUserProfile"
}
},
"x-stoplight": {
"id": "5myohv0b06lge"
}
},
"ContactExportError": {
"required": [
"success",
"error"
],
"type": "object",
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"title": "Error",
"type": "string",
"enum": [
"no_contacts"
]
}
},
"x-stoplight": {
"id": "gxl7vj77nizri"
}
},
"FilterAudienceAge": {
"description": " At least one of the provided ranges should be more than the specified percentage.",
"required": [
"code"
],
"type": "object",
"properties": {
"code": {
"title": "Code",
"type": "string",
"enum": [
"18-24",
"25-34",
"35-44",
"45-64",
"65-"
]
},
"weight": {
"title": "Weight",
"type": "number",
"default": 0.25
}
},
"x-stoplight": {
"id": "47zar7e6p6x2i"
}
},
"FilterAudienceAgeRange": {
"description": "",
"type": "object",
"properties": {
"left_number": {
"title": "Left number",
"type": "string",
"enum": [
null,
13,
18,
25,
35,
45,
65
]
},
"right_number": {
"title": "Right number",
"type": "string",
"enum": [
null,
17,
24,
34,
44,
64
]
},
"weight": {
"title": "Weight",
"type": "number",
"default": 0.25
},
"operator": {
"title": "Operator",
"type": "string",
"enum": [
"lt",
"lte",
"gt",
"gte"
],
"default": "gte"
}
},
"x-stoplight": {
"id": "ggz6xafvib92q"
}
},
"FilterHiddenLikePostsRate": {
"description": " Filters creators based on the percentage of posts with hidden likes.",
"required": [
"weight"
],
"type": "object",
"properties": {
"weight": {
"title": "Weight",
"type": "number"
},
"operator": {
"title": "Operator",
"type": "string",
"enum": [
"lt",
"lte",
"gt",
"gte"
],
"default": "gte"
}
},
"x-stoplight": {
"id": "injqdx6w0lbgv"
}
},
"FilterAudienceBrand": {
"description": " No more than 20 values. If multiple values provided, then the user must be matched to at least one of them.",
"required": [
"id"
],
"type": "object",
"properties": {
"id": {
"title": "Id",
"type": "integer"
},
"weight": {
"title": "Weight",
"type": "number",
"default": 0.1
}
},
"x-stoplight": {
"id": "a2znasgv8p9la"
}
},
"FilterAudienceGender": {
"description": "",
"required": [
"code"
],
"type": "object",
"properties": {
"code": {
"title": "Code",
"type": "string",
"enum": [
"MALE",
"FEMALE"
]
},
"weight": {
"title": "Weight",
"type": "number",
"default": 0.5
}
},
"x-stoplight": {
"id": "8p7ryuvmrmbos"
}
},
"FilterAudienceGeo": {
"description": " No more than 20 values. If multiple values provided, then the user must be matched to at least one of them.",
"required": [
"id"
],
"type": "object",
"properties": {
"id": {
"title": "Id",
"description": "You can get a valid ID from geos dictionary",
"type": "integer"
},
"weight": {
"title": "Weight",
"type": "number",
"default": 0.05
}
},
"x-stoplight": {
"id": "osh1bd8trhxrz"
}
},
"FilterAudienceLang": {
"description": "",
"required": [
"code"
],
"type": "object",
"properties": {
"code": {
"title": "Code",
"description": "You can get a valid language code from our dictionary",
"type": "string",
"maxLength": 2,
"minLength": 1
},
"weight": {
"title": "Weight",
"type": "number",
"default": 0.2
}
},
"x-stoplight": {
"id": "6ybk381t5o63m"
}
},
"FilterAudienceRace": {
"description": "",
"required": [
"code"
],
"type": "object",
"properties": {
"code": {
"title": "Code",
"type": "string",
"enum": [
"Black",
"Asian",
"White",
"Hispanic"
]
},
"weight": {
"title": "Weight",
"type": "number",
"default": 0.3
}
},
"x-stoplight": {
"id": "zxfznm3d56mk0"
}
},
"FilterAudienceRelevance": {
"description": " Has lookalike audience as of specified influencer. For example \"@topgear\" means \"Has audience lookalike audience of @topgear account\". Lookalike means that audience follows accounts with the same topic as an audience of specified account.",
"required": [
"value"
],
"type": "object",
"properties": {
"value": {
"title": "Value",
"type": "string",
"minLength": 1
}
},
"x-stoplight": {
"id": "2qshqc820mc86"
}
},
"FilterEngagementsRange": {
"description": " We round engagements value in the filter: whenever it’s below 500, we round it to the nearest hundred (412 -> 400; 480-> 500); when it’s between 500 and 1000, we round it to the nearest 5,00 (700 -> 500; 800 -> 1000); when it’s over 1k, we rount it to the nearest 1,000 (5400 -> 5k; 5500 -> 6k)",
"type": "object",
"properties": {
"left_number": {
"title": "Left number",
"type": "integer"
},
"right_number": {
"title": "Right number",
"type": "integer"
}
},
"x-stoplight": {
"id": "959h26dto76aa"
}
},
"FilterViewsRange": {
"description": " We round views value in the filter to the nearest thousand (1400 -> 1k; 1500-> 2k).",
"type": "object",
"properties": {
"left_number": {
"title": "Left number",
"type": "integer"
},
"right_number": {
"title": "Right number",
"type": "integer"
}
},
"x-stoplight": {
"id": "r9dvr9qi3zp4e"
}
},
"FilterPostsCountRange": {
"description": "",
"type": "object",
"properties": {
"left_number": {
"title": "Left number",
"type": "integer"
},
"right_number": {
"title": "Right number",
"type": "integer"
}
},
"x-stoplight": {
"id": "nx5xbajkz0i5e"
}
},
"FilterReelsPlaysRange": {
"description": " We round reels plays value in the filter to the nearest thousand (1400 -> 1k; 1500-> 2k).",
"type": "object",
"properties": {
"left_number": {
"title": "Left number",
"type": "integer"
},
"right_number": {
"title": "Right number",
"type": "integer"
}
},
"x-stoplight": {
"id": "20hm87xowlxt0"
}
},
"FilterSharesRange": {
"description": " We round shares value in the filter: whenever it’s below 500, we round it to the nearest hundred (412 -> 400; 480-> 500); when it’s between 500 and 1000, we round it to the nearest 5,00 (700 -> 500; 800 -> 1000); when it’s over 1k, we rount it to the nearest 1,000 (5400 -> 5k; 5500 -> 6k)",
"type": "object",
"properties": {
"left_number": {
"title": "Left number",
"type": "integer"
},
"right_number": {
"title": "Right number",
"type": "integer"
}
},
"x-stoplight": {
"id": "n7qll8vtfy88e"
}
},
"FilterSavesRange": {
"description": " We round saves value in the filter: whenever it’s below 500, we round it to the nearest hundred (412 -> 400; 480-> 500); when it’s between 500 and 1000, we round it to the nearest 5,00 (700 -> 500; 800 -> 1000); when it’s over 1k, we rount it to the nearest 1,000 (5400 -> 5k; 5500 -> 6k)",
"type": "object",
"properties": {
"left_number": {
"title": "Left number",
"type": "integer"
},
"right_number": {
"title": "Right number",
"type": "integer"
}
},
"x-stoplight": {
"id": "an5jz30fgxoc6"
}
},
"FilterFollowersRange": {
"description": " We round followers value in the filter: whenever it’s below 5k, we round it to the nearest thousand (4123 -> 4000; 4800-> 5000); when it’s over 5k, we round it to the nearest 5,000 (27k -> 25k; 28k -> 30k).",
"type": "object",
"properties": {
"left_number": {
"title": "Left number",
"type": "integer"
},
"right_number": {
"title": "Right number",
"type": "integer"
}
},
"x-stoplight": {
"id": "l90zqh21xfav3"
}
},
"FilterGender": {
"description": "",
"required": [
"code"
],
"type": "object",
"properties": {
"code": {
"title": "Code",
"type": "string",
"enum": [
"MALE",
"FEMALE",
"KNOWN",
"UNKNOWN"
]
}
},
"x-stoplight": {
"id": "82hdj86z4vr8u"
}
},
"FilterAgeRange": {
"description": "",
"type": "object",
"properties": {
"left_number": {
"title": "Left number",
"type": "string",
"enum": [
null,
18,
25,
35,
45,
65
]
},
"right_number": {
"title": "Right number",
"type": "string",
"enum": [
null,
18,
25,
35,
45,
65
]
}
},
"x-stoplight": {
"id": "uesqpawbnphva"
}
},
"FilterGeo": {
"description": " No more than 20 values. If multiple values provided, then the user must be matched to at least one of them.",
"required": [
"id"
],
"type": "object",
"properties": {
"id": {
"title": "Id",
"description": "You can get a valid ID from geos dictionary",
"type": "integer"
}
},
"x-stoplight": {
"id": "ojtvcvt4ip57p"
}
},
"FilterLang": {
"description": "",
"required": [
"code"
],
"type": "object",
"properties": {
"code": {
"title": "Code",
"description": "You can get a valid language code from our dictionary",
"type": "string",
"maxLength": 2,
"minLength": 1
}
},
"x-stoplight": {
"id": "5oxw60htavpad"
}
},
"FilterFollowersGrowth": {
"description": "",
"required": [
"value"
],
"type": "object",
"properties": {
"interval": {
"title": "Interval",
"type": "string",
"enum": [
"i1month",
"i2months",
"i3months",
"i4months",
"i5months",
"i6months"
],
"default": "i1month"
},
"value": {
"title": "Value",
"type": "number"
},
"operator": {
"title": "Operator",
"type": "string",
"enum": [
"lt",
"lte",
"gt",
"gte"
],
"default": "gte"
}
},
"x-stoplight": {
"id": "d4fheqiebr2b6"
}
},
"FilterTotalViewsGrowth": {
"description": "",
"required": [
"value"
],
"type": "object",
"properties": {
"interval": {
"title": "Interval",
"type": "string",
"enum": [
"i1month",
"i2months",
"i3months",
"i4months",
"i5months",
"i6months"
],
"default": "i1month"
},
"value": {
"title": "Value",
"type": "number"
},
"operator": {
"title": "Operator",
"type": "string",
"enum": [
"lt",
"lte",
"gt",
"gte"
],
"default": "gte"
}
},
"x-stoplight": {
"id": "oj50kuwyhu91x"
}
},
"FilterTotalLikesGrowth": {
"description": "",
"required": [
"value"
],
"type": "object",
"properties": {
"interval": {
"title": "Interval",
"type": "string",
"enum": [
"i1month",
"i2months",
"i3months",
"i4months",
"i5months",
"i6months"
],
"default": "i1month"
},
"value": {
"title": "Value",
"type": "number"
},
"operator": {
"title": "Operator",
"type": "string",
"enum": [
"lt",
"lte",
"gt",
"gte"
],
"default": "gte"
}
},
"x-stoplight": {
"id": "29kixqw4zrtm4"
}
},
"FilterRelevance": {
"description": " Filter by topic of influencers posts of by similarity of topic to other influencer. For example \"#cars #audi @topgear\" means \"Writing about #cars and #audi, has similar topic as @topgear account\"",
"required": [
"value"
],
"type": "object",
"properties": {
"value": {
"title": "Value",
"type": "string",
"minLength": 1
},
"weight": {
"title": "Weight",
"type": "number",
"default": 0.5,
"maximum": 1,
"minimum": 0
},
"threshold": {
"title": "Threshold",
"description": "Threshold on relevance distance. You can view distance on search results while searching by relevance.",
"type": "number",
"default": 0.55,
"maximum": 1,
"minimum": 0
}
},
"x-stoplight": {
"id": "4bwx5qmquu35c"
}
},
"FilterTextAdvanced": {
"description": " Search phrase within influencer BIO or full name with logical operators _AND_, _OR_, _NOT_",
"required": [
"text",
"action"
],
"type": "object",
"properties": {
"text": {
"title": "Text",
"description": "Text to search for",
"type": "string",
"minLength": 1
},
"action": {
"title": "Action",
"description": "Include (`must`, `should`) or exclude (`not`) influencers from search results.\nEvaluation: must && must && (should || should) && !not && !not",
"type": "string",
"enum": [
"must",
"should",
"not"
]
}
},
"x-stoplight": {
"id": "bayidwez02gjr"
}
},
"FilterTextTag": {
"description": " No more than 20 values.",
"required": [
"type",
"value"
],
"type": "object",
"properties": {
"type": {
"title": "Type",
"description": "Mention or hashtag means how the value has been used in the influencer's post. To specify where the mention has been used - in the text or on the photo, use `text_mention` or `photo_mention` type.",
"type": "string",
"enum": [
"hashtag",
"mention",
"text_mention",
"photo_mention"
]
},
"value": {
"title": "Value",
"description": "Hashtag or mention to search for, without `@` or `#`",
"type": "string",
"minLength": 1
},
"action": {
"title": "Action",
"description": "Include only (`must`, `should`) or exclude (`not`) influencers from search results. Evaluation: must && must && (should || should) && !not && !not",
"type": "string",
"enum": [
"must",
"should",
"not"
],
"default": "should"
}
},
"x-stoplight": {
"id": "m9bmwderuiy3h"
}
},
"FilterEngagementRate": {
"description": "",
"required": [
"value"
],
"type": "object",
"properties": {
"value": {
"title": "Value",
"type": "number"
},
"operator": {
"title": "Operator",
"type": "string",
"enum": [
"lt",
"lte",
"gt",
"gte"
],
"default": "gte"
}
},
"x-stoplight": {
"id": "in5l86r7hl8ie"
}
},
"FilterWithContact": {
"description": "",
"required": [
"type"
],
"type": "object",
"properties": {
"type": {
"title": "Type",
"type": "string",
"enum": [
"bbm",
"email",
"facebook",
"instagram",
"itunes",
"kakao",
"kik",
"lineid",
"linktree",
"phone",
"pinterest",
"sarahah",
"sayat",
"skype",
"snapchat",
"telegram",
"threads",
"tiktok",
"tumblr",
"twitchtv",
"twitter",
"viber",
"vk",
"wechat",
"weibo",
"whatsapp",
"youtube"
]
},
"action": {
"title": "Action",
"description": "Include only (`must`, `should`) or exclude (`not`) influencers from search results. Evaluation: must && must && (should || should) && !not && !not",
"type": "string",
"enum": [
"must",
"should",
"not"
],
"default": "should"
}
},
"x-stoplight": {
"id": "vuy8c2qetkhci"
}
},
"FilterNotableUsersRatio": {
"description": " This filter allows you to select influencers based on the share of notable users in their audience. Notable users are followers with 1k+ followers.",
"required": [
"value"
],
"type": "object",
"properties": {
"value": {
"title": "Value",
"description": "Value",
"type": "number"
},
"operator": {
"title": "Operator",
"description": "Operator",
"type": "string",
"enum": [
"lt",
"lte",
"gt",
"gte"
],
"default": "gte"
}
},
"x-stoplight": {
"id": "virr53eluoaxf"
}
},
"FilterLists": {
"description": "",
"required": [
"id"
],
"type": "object",
"properties": {
"id": {
"title": "Id",
"description": "ID for list to use. You can get it from [this endpoint](#operation/list-list-of-influencers)",
"type": "integer"
},
"action": {
"title": "Action",
"description": "Include only (`must`, `should`) or exclude (`not`) influencers from search results. Evaluation: must && must && (should || should) && !not && !not",
"type": "string",
"enum": [
"must",
"should",
"not"
],
"default": "should"
}
},
"x-stoplight": {
"id": "ayapyq8e816nw"
}
},
"FilterUsername": {
"description": " Filter by influencers username. If filter is specified then there will be no highlight of any audience data (audience geo, gender and so on)",
"required": [
"value"
],
"type": "object",
"properties": {
"value": {
"title": "Value",
"type": "string",
"minLength": 1
},
"operator": {
"title": "Operator",
"type": "string",
"enum": [
"prefix",
"exact"
],
"default": "prefix"
}
},
"x-stoplight": {
"id": "1d96hj6e2dkwn"
}
},
"FilterSearchActions": {
"description": " Change filters mixing logic from AND to OR or NOT. For example, search for 'Followers > 1m AND NOT from United States', or 'Female OR having interest Beauty'.",
"required": [
"filter"
],
"type": "object",
"properties": {
"filter": {
"title": "Filter",
"description": "If `keywords` or `relevance` specified then you can not sort by this field",
"type": "string",
"enum": [
"followers",
"engagements",
"views",
"engagement_rate",
"last_posted",
"text",
"keywords",
"relevance",
"lang",
"gender",
"age",
"geo",
"brand_category",
"brand",
"with_contact",
"account_type",
"is_verified",
"is_hidden",
"is_official_artist",
"has_ads",
"ads_brands",
"has_audience_data",
"username",
"list",
"filter_ids",
"audience_credibility",
"audience_credibility_class"
]
},
"action": {
"title": "Action",
"description": "Evaluation of all filters specified in the request: must && must && (should || should) && !not && !not. By default they all are `must`, can be switched here to `should` or `not`",
"type": "string",
"enum": [
"must",
"should",
"not"
],
"default": "must"
}
},
"x-stoplight": {
"id": "26el5dy7qib1g"
}
},
"FilterSemantic": {
"description": " Search for creators based on the meaning of your query. Instead of matching exact keywords, the system analyzes the content of influencer posts to identify profiles that talk about similar concepts.\n- Max 1000 characters\n- One query per request",
"required": [
"query"
],
"type": "object",
"properties": {
"query": {
"title": "Query",
"description": "Search query for semantic search. Max 1000 characters.",
"type": "string",
"maxLength": 1000,
"minLength": 1
}
},
"x-stoplight": {
"id": "d69pbofb5xs3m"
}
},
"SearchFilters": {
"type": "object",
"properties": {
"account_category": {
"title": "Account category",
"description": "",
"type": "string",
"minLength": 1
},
"audience_age": {
"description": " At least one of the provided ranges should be more than the specified percentage.",
"type": "array",
"items": {
"$ref": "#/components/schemas/FilterAudienceAge"
}
},
"audience_age_range": {
"$ref": "#/components/schemas/FilterAudienceAgeRange"
},
"hidden_like_posts_rate": {
"$ref": "#/components/schemas/FilterHiddenLikePostsRate"
},
"audience_brand": {
"description": " No more than 20 values. If multiple values provided, then the user must be matched to at least one of them.",
"type": "array",
"items": {
"$ref": "#/components/schemas/FilterAudienceBrand"
}
},
"audience_brand_category": {
"description": " No more than 20 values. If multiple values provided, then the user must be matched to at least one of them.",
"type": "array",
"items": {
"$ref": "#/components/schemas/FilterAudienceBrand"
}
},
"audience_gender": {
"$ref": "#/components/schemas/FilterAudienceGender"
},
"audience_geo": {
"description": " No more than 20 values. If multiple values provided, then the user must be matched to at least one of them.",
"type": "array",
"items": {
"$ref": "#/components/schemas/FilterAudienceGeo"
}
},
"audience_lang": {
"$ref": "#/components/schemas/FilterAudienceLang"
},
"audience_race": {
"$ref": "#/components/schemas/FilterAudienceRace"
},
"audience_relevance": {
"$ref": "#/components/schemas/FilterAudienceRelevance"
},
"brand": {
"description": " You can get a valid brand ID from our dictionary. No more than 20 values. If multiple values provided, then the user must be matched to at least one of them.",
"type": "array",
"items": {
"type": "integer"
}
},
"brand_category": {
"description": " You can get a valid interest (brand category) ID from our dictionary. No more than 20 values. If multiple values provided, then the user must be matched to at least one of them.",
"type": "array",
"items": {
"type": "integer"
}
},
"engagements": {
"$ref": "#/components/schemas/FilterEngagementsRange"
},
"views": {
"$ref": "#/components/schemas/FilterViewsRange"
},
"posts_count": {
"$ref": "#/components/schemas/FilterPostsCountRange"
},
"reels_plays": {
"$ref": "#/components/schemas/FilterReelsPlaysRange"
},
"shares": {
"$ref": "#/components/schemas/FilterSharesRange"
},
"saves": {
"$ref": "#/components/schemas/FilterSavesRange"
},
"followers": {
"$ref": "#/components/schemas/FilterFollowersRange"
},
"gender": {
"$ref": "#/components/schemas/FilterGender"
},
"age": {
"$ref": "#/components/schemas/FilterAgeRange"
},
"geo": {
"description": " No more than 20 values. If multiple values provided, then the user must be matched to at least one of them.",
"type": "array",
"items": {
"$ref": "#/components/schemas/FilterGeo"
}
},
"lang": {
"$ref": "#/components/schemas/FilterLang"
},
"followers_growth": {
"$ref": "#/components/schemas/FilterFollowersGrowth"
},
"total_views_growth": {
"$ref": "#/components/schemas/FilterTotalViewsGrowth"
},
"total_likes_growth": {
"$ref": "#/components/schemas/FilterTotalLikesGrowth"
},
"relevance": {
"$ref": "#/components/schemas/FilterRelevance"
},
"text": {
"title": "Text",
"description": " Search phrase within influencer BIO or full name. It supports the following operators:\n- space signifies _AND_ operation\n- `|` signifies _OR_ operation\n- `-` negates a single token\n\nExample: `tech | dev -crypto`",
"type": "string",
"minLength": 1
},
"text_advanced": {
"description": " Search phrase within influencer BIO or full name with logical operators _AND_, _OR_, _NOT_",
"type": "array",
"items": {
"$ref": "#/components/schemas/FilterTextAdvanced"
}
},
"keywords": {
"title": "Keywords",
"description": " Search phrase influencers use in their posts texts.\n\n Search phrase influencers use when speaking in their videos.",
"type": "string",
"minLength": 1
},
"text_tags": {
"description": " No more than 20 values.",
"type": "array",
"items": {
"$ref": "#/components/schemas/FilterTextTag"
}
},
"engagement_rate": {
"$ref": "#/components/schemas/FilterEngagementRate"
},
"is_hidden": {
"title": "Is hidden",
"description": " Shows only private (=true) or public (=false) accounts.",
"type": "boolean"
},
"is_verified": {
"title": "Is verified",
"description": " Shows only verified if `true` value passed.",
"type": "boolean"
},
"account_type": {
"description": " Filter by account types, 1 - Regular, 2 - Business, 3 - Creator. For example, to get business or creator accounts pass [2,3] value to this filter.",
"type": "array",
"items": {
"type": "integer"
}
},
"has_ads": {
"title": "Has ads",
"description": " If `true` value passed then shows accounts only having sponsored posts",
"type": "boolean"
},
"ads_brands": {
"description": " Has sponsored posts with a least one of these brands",
"type": "array",
"items": {
"type": "integer"
}
},
"with_contact": {
"description": "",
"type": "array",
"items": {
"$ref": "#/components/schemas/FilterWithContact"
}
},
"audience_credibility": {
"title": "Audience credibility",
"description": " Minimum audience credibility for audience of the influencer",
"type": "number"
},
"audience_credibility_class": {
"description": " Filter by audience_credibility class. Pass one of or multiple values - ['bad', 'low', 'normal', 'high', 'best']",
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
},
"notable_users_ratio": {
"$ref": "#/components/schemas/FilterNotableUsersRatio"
},
"list": {
"description": "",
"type": "array",
"items": {
"$ref": "#/components/schemas/FilterLists"
}
},
"filter_ids": {
"description": " Filter by specified list of user IDs, up to 1000 IDs. Use in combination with `actions` filter to exclude accounts from the result",
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
},
"is_official_artist": {
"title": "Is official artist",
"description": " Exclude(=false) or show only (=true) channels with Official artist label",
"type": "boolean"
},
"last_posted": {
"title": "Last posted",
"description": " Maximum number of days since last post of influencer",
"type": "integer",
"minimum": 30
},
"has_audience_data": {
"title": "Has audience data",
"description": " If `true` value passed then shows only accounts having audience data report",
"type": "boolean"
},
"username": {
"$ref": "#/components/schemas/FilterUsername"
},
"actions": {
"description": " Change filters mixing logic from AND to OR or NOT. For example, search for 'Followers > 1m AND NOT from United States', or 'Female OR having interest Beauty'.",
"type": "array",
"items": {
"$ref": "#/components/schemas/FilterSearchActions"
}
},
"post_type": {
"title": "Post type",
"description": " Filters posts by type. Possible values:\n\n - `all`\n\n - `all`, `videos`, `shorts`, `streams`.",
"type": "string",
"enum": [
"all",
"videos",
"shorts",
"streams"
],
"default": "all"
},
"semantic": {
"$ref": "#/components/schemas/FilterSemantic"
},
"no_known_location": {
"title": "No known location",
"description": " Filter profiles with no location data available. Cannot be used together with the geo filter.",
"type": "boolean"
}
},
"x-stoplight": {
"id": "ep2a3fygwpeuw"
}
},
"SearchSortSerializer": {
"required": [
"field"
],
"type": "object",
"properties": {
"field": {
"title": "Field",
"type": "string",
"enum": [
"engagements",
"followers",
"engagement_rate",
"keywords",
"views",
"posts_count",
"reels_plays",
"shares",
"saves",
"followers_growth",
"total_views_growth",
"total_likes_growth",
"audience_geo",
"audience_lang",
"audience_brand",
"audience_brand_category",
"audience_gender",
"audience_age",
"relevance",
"audience_relevance",
"semantic"
]
},
"id": {
"title": "Id",
"description": "Affects only for sort by audience_geo, audience_brand or audience_brand_category fields to specify most audience segment to sort by according to your filter",
"type": "integer"
},
"direction": {
"title": "Direction",
"type": "string",
"enum": [
"desc"
],
"default": "desc"
}
},
"x-stoplight": {
"id": "jiopn0i8kb7e4"
}
},
"DataExportLimitPaging": {
"required": [
"limit"
],
"type": "object",
"properties": {
"limit": {
"title": "Limit",
"type": "integer"
}
},
"x-stoplight": {
"id": "j1m5lvliha3zh"
}
},
"NewDataExportRequest": {
"required": [
"filter",
"sort",
"paging",
"audience_source",
"export_type"
],
"type": "object",
"properties": {
"filter": {
"$ref": "#/components/schemas/SearchFilters"
},
"sort": {
"$ref": "#/components/schemas/SearchSortSerializer"
},
"paging": {
"$ref": "#/components/schemas/DataExportLimitPaging"
},
"audience_source": {
"title": "Audience source",
"description": "What audience to use for filters - likers, followers, commenters or any matched to the filter. By default filters by first audience report we have in this order - followers, likers, commenters. Meaning that if influencer has followers data then filter by followers only. If there are no followers data then by likers. By commenters if there are no followers and likers.",
"type": "string",
"enum": [
"any",
"likers",
"followers",
"commenters"
]
},
"dry_run": {
"title": "Dry run",
"description": "Calculate costs instead of real data export",
"type": "boolean"
},
"export_type": {
"title": "Export type",
"type": "string",
"enum": [
"FULL",
"SHORT"
]
},
"send_email": {
"title": "Send email",
"description": "Whether to send an email when the report is ready",
"type": "boolean",
"default": false
}
},
"x-stoplight": {
"id": "km3772y09ust2"
}
},
"NotableExportDryRun": {
"required": [
"count",
"cost"
],
"type": "object",
"properties": {
"count": {
"title": "Count",
"description": "Number of notable users we have for your criteria",
"type": "integer"
},
"has_email": {
"title": "Has email",
"description": "Number of notable users who also has an email",
"type": "integer"
},
"cost": {
"title": "Cost",
"description": "Cost of this data export",
"type": "number"
}
},
"x-stoplight": {
"id": "yenq3j37m4ilt"
}
},
"ExportUserProfile": {
"required": [
"engagement_rate",
"engagements",
"followers",
"url",
"user_id"
],
"type": "object",
"properties": {
"account_type": {
"title": "Account type",
"description": "",
"type": "integer",
"enum": [
1,
2,
3
]
},
"age_group": {
"title": "Age group",
"type": "string",
"minLength": 1
},
"avg_likes": {
"title": "Avg likes",
"type": "integer"
},
"avg_views": {
"title": "Avg views",
"description": "",
"type": "integer"
},
"brand_affinity": {
"description": "",
"type": "array",
"items": {
"$ref": "#/components/schemas/Brand"
}
},
"contacts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Contact"
}
},
"custom_name": {
"title": "Custom name",
"description": "",
"type": "string",
"minLength": 1
},
"description": {
"title": "Description",
"type": "string"
},
"engagement_rate": {
"title": "Engagement rate",
"type": "number"
},
"engagements": {
"title": "Engagements",
"type": "integer"
},
"followers": {
"title": "Followers",
"type": "integer"
},
"fullname": {
"title": "Fullname",
"type": "string",
"minLength": 1
},
"gender": {
"title": "Gender",
"type": "string",
"enum": [
"MALE",
"FEMALE"
]
},
"geo": {
"$ref": "#/components/schemas/Geo"
},
"handle": {
"title": "Handle",
"description": "",
"type": "string",
"minLength": 1
},
"interests": {
"description": "",
"type": "array",
"items": {
"$ref": "#/components/schemas/Interest"
}
},
"is_verified": {
"title": "Is verified",
"type": "boolean"
},
"language": {
"$ref": "#/components/schemas/Language"
},
"picture": {
"title": "Picture",
"type": "string",
"minLength": 1
},
"sec_uid": {
"title": "Sec uid",
"description": "",
"type": "string",
"minLength": 1
},
"url": {
"title": "Url",
"type": "string",
"minLength": 1
},
"user_id": {
"title": "User id",
"type": "string",
"minLength": 1
},
"username": {
"title": "Username",
"type": "string",
"minLength": 1
},
"first_name": {
"title": "First name",
"type": "string",
"minLength": 1
}
},
"x-stoplight": {
"id": "efm8ckca8xpck"
}
},
"ExportAudienceData": {
"required": [
"audience_source",
"user_profile"
],
"type": "object",
"properties": {
"audience_source": {
"title": "Audience source",
"type": "string",
"minLength": 1
},
"user_profile": {
"$ref": "#/components/schemas/ExportUserProfile"
}
},
"x-stoplight": {
"id": "f91x3p5msosju"
}
},
"AudienceAge": {
"required": [
"code",
"weight"
],
"type": "object",
"properties": {
"code": {
"title": "Code",
"type": "string",
"enum": [
"13-17",
"18-24",
"25-34",
"35-44",
"45-64",
"65-"
]
},
"weight": {
"title": "Weight",
"type": "number"
}
},
"x-stoplight": {
"id": "cjthm75i491bb"
}
},
"AudienceAgeRange": {
"required": [
"code",
"weight"
],
"type": "object",
"properties": {
"code": {
"title": "Code",
"description": "Age range in format `{min age}-{max age}`, e.g. `13-44` or `45-64`. `{max age}` will be omitted if `right_number` is not specified, e.g. `45-` matches all the audience of age 45+.",
"type": "string",
"minLength": 1
},
"weight": {
"title": "Weight",
"type": "number"
}
},
"x-stoplight": {
"id": "mlq6gtiogk11c"
}
},
"AudienceBrand": {
"required": [
"id",
"name",
"weight",
"affinity"
],
"type": "object",
"properties": {
"id": {
"title": "Id",
"type": "integer"
},
"name": {
"title": "Name",
"type": "string",
"minLength": 1
},
"interest": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Interest"
}
},
"weight": {
"title": "Weight",
"description": "The percentage of audience interested in. We cut off brands with a value less than 0.005 (0.5%)",
"type": "number"
},
"affinity": {
"title": "Affinity",
"description": "Measure of how volume of influencer's audience interested in specific brand relates to average on Instagram. 1.0 means the same as on average, 2.0 means 2 times more than usual on Instagram.",
"type": "number"
}
},
"x-stoplight": {
"id": "8pzhyq6iwg1vd"
}
},
"AudienceEthnicity": {
"required": [
"code",
"name",
"weight"
],
"type": "object",
"properties": {
"code": {
"title": "Code",
"type": "string",
"enum": [
"white",
"asian",
"african_american",
"hispanic"
]
},
"name": {
"title": "Name",
"type": "string",
"enum": [
"White / Caucasian",
"Asian",
"African American",
"Hispanic"
]
},
"weight": {
"title": "Weight",
"type": "number"
}
},
"x-stoplight": {
"id": "olqvv0955ohgx"
}
},
"AudienceGender": {
"required": [
"code",
"weight"
],
"type": "object",
"properties": {
"code": {
"title": "Code",
"type": "string",
"enum": [
"MALE",
"FEMALE"
]
},
"weight": {
"title": "Weight",
"type": "number"
}
},
"x-stoplight": {
"id": "dknhxe7piielo"
}
},
"AudienceGenderPerAge": {
"required": [
"code",
"male",
"female"
],
"type": "object",
"properties": {
"code": {
"title": "Code",
"type": "string",
"enum": [
"13-17",
"18-24",
"25-34",
"35-44",
"45-64",
"65-"
]
},
"male": {
"title": "Male",
"type": "number"
},
"female": {
"title": "Female",
"type": "number"
}
},
"x-stoplight": {
"id": "evq6t3ransidp"
}
},
"AudienceGeoCountry": {
"required": [
"id",
"name",
"code",
"weight"
],
"type": "object",
"properties": {
"id": {
"title": "Id",
"type": "integer"
},
"name": {
"title": "Name",
"type": "string",
"minLength": 1
},
"code": {
"title": "Code",
"type": "string",
"minLength": 1
},
"weight": {
"title": "Weight",
"description": "We cut off countries with a value less than 0.01 (1%) but no less than 7 countries",
"type": "number"
}
},
"x-stoplight": {
"id": "imr2qvbvxhhaf"
}
},
"EmbedGeoCountry": {
"required": [
"id",
"name",
"code"
],
"type": "object",
"properties": {
"id": {
"title": "Id",
"type": "integer"
},
"name": {
"title": "Name",
"type": "string",
"minLength": 1
},
"code": {
"title": "Code",
"type": "string",
"minLength": 1
}
},
"x-stoplight": {
"id": "s9wu73g3h0uhc"
}
},
"AudienceGeoState": {
"required": [
"id",
"name",
"weight",
"country"
],
"type": "object",
"properties": {
"id": {
"title": "Id",
"type": "integer"
},
"name": {
"title": "Name",
"type": "string",
"minLength": 1
},
"weight": {
"title": "Weight",
"description": "We cut off US states with a value less than 0.005 (0.5%) but no less than 7 US states",
"type": "number"
},
"country": {
"$ref": "#/components/schemas/EmbedGeoCountry"
}
},
"x-stoplight": {
"id": "9ukq1p92t10s1"
}
},
"AudienceGeoCity": {
"required": [
"id",
"name",
"weight",
"country"
],
"type": "object",
"properties": {
"id": {
"title": "Id",
"type": "integer"
},
"name": {
"title": "Name",
"type": "string",
"minLength": 1
},
"coords": {
"$ref": "#/components/schemas/Coords"
},
"weight": {
"title": "Weight",
"description": "We cut off cities with a value less than 0.005 (0.5%) but no less than 7 cities",
"type": "number"
},
"country": {
"$ref": "#/components/schemas/EmbedGeoCountry"
}
},
"x-stoplight": {
"id": "3qndnxeruag1w"
}
},
"AudienceGeo": {
"required": [
"countries",
"states",
"cities"
],
"type": "object",
"properties": {
"countries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AudienceGeoCountry"
}
},
"states": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AudienceGeoState"
}
},
"cities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AudienceGeoCity"
}
},
"subdivisions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Subdivision"
}
}
},
"x-stoplight": {
"id": "e2for1vd71lzi"
}
},
"AudienceInterest": {
"required": [
"id",
"name",
"weight"
],
"type": "object",
"properties": {
"id": {
"title": "Id",
"type": "integer"
},
"name": {
"title": "Name",
"type": "string",
"minLength": 1
},
"weight": {
"title": "Weight",
"description": "The percentage of audience interested in. We cut off interests with a value less than 0.015 (1.5%)",
"type": "number"
}
},
"x-stoplight": {
"id": "m830oo86uk3tp"
}
},
"AudienceLanguage": {
"required": [
"code",
"name",
"weight"
],
"type": "object",
"properties": {
"code": {
"title": "Code",
"type": "string",
"enum": [
"af",
"als",
"am",
"an",
"ar",
"arz",
"as",
"ast",
"av",
"az",
"azb",
"ba",
"bar",
"bcl",
"be",
"bg",
"bh",
"bn",
"bo",
"bpy",
"br",
"bs",
"bxr",
"ca",
"cbk",
"ce",
"ceb",
"ckb",
"co",
"cs",
"cv",
"cy",
"da",
"de",
"diq",
"dsb",
"dty",
"dv",
"dz",
"el",
"eml",
"en",
"eo",
"es",
"et",
"eu",
"fa",
"fi",
"fo",
"fr",
"frr",
"fy",
"ga",
"gd",
"gl",
"gn",
"gom",
"gu",
"gv",
"he",
"hi",
"hif",
"hr",
"hsb",
"ht",
"hu",
"hy",
"ia",
"id",
"ie",
"ilo",
"in",
"io",
"is",
"it",
"ja",
"jbo",
"jv",
"ka",
"kk",
"km",
"kn",
"ko",
"krc",
"ku",
"kv",
"kw",
"ky",
"la",
"lb",
"lez",
"li",
"lmo",
"lo",
"lrc",
"lt",
"lv",
"mai",
"mg",
"mhr",
"min",
"mk",
"ml",
"mn",
"mr",
"mrj",
"ms",
"mt",
"mwl",
"my",
"myv",
"mzn",
"nah",
"nap",
"nb",
"nds",
"ne",
"new",
"nl",
"nn",
"no",
"oc",
"or",
"os",
"pa",
"pam",
"pfl",
"pl",
"pms",
"pnb",
"ps",
"pt",
"qu",
"rm",
"ro",
"ru",
"rue",
"rw",
"sa",
"sah",
"sc",
"scn",
"sco",
"sd",
"se",
"sh",
"si",
"sk",
"sl",
"so",
"sq",
"sr",
"su",
"sv",
"sw",
"ta",
"te",
"tg",
"th",
"tk",
"tl",
"tr",
"tt",
"tyv",
"ug",
"uk",
"ur",
"uz",
"vec",
"vep",
"vi",
"vls",
"vo",
"wa",
"war",
"wuu",
"xal",
"xh",
"xmf",
"yi",
"yo",
"yue",
"zh",
"zh-Hant",
"zu"
]
},
"name": {
"title": "Name",
"description": "Name of the language in English",
"type": "string",
"minLength": 1
},
"weight": {
"title": "Weight",
"description": "We cut off languages with a value less than 0.01 (1%) but no less than 7 language",
"type": "number"
}
},
"x-stoplight": {
"id": "lzncv6imrjz7e"
}
},
"MatchAudienceStats": {
"type": "object",
"properties": {
"audience_ages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AudienceAge"
}
},
"audience_age_range": {
"$ref": "#/components/schemas/AudienceAgeRange"
},
"audience_brand_affinity": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AudienceBrand"
}
},
"audience_credibility": {
"title": "Audience credibility",
"type": "number"
},
"audience_ethnicities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AudienceEthnicity"
}
},
"audience_genders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AudienceGender"
}
},
"audience_genders_per_age": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AudienceGenderPerAge"
}
},
"audience_geo": {
"$ref": "#/components/schemas/AudienceGeo"
},
"audience_interests": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AudienceInterest"
}
},
"audience_languages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AudienceLanguage"
}
},
"credibility_class": {
"title": "Credibility class",
"type": "string",
"minLength": 1
},
"relevance": {
"title": "Relevance",
"type": "number"
}
},
"x-stoplight": {
"id": "8hbgvnt0ahgzk"
}
},
"MatchAudience": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/MatchAudienceStats"
}
},
"x-stoplight": {
"id": "mqm1bj68gqnhd"
}
},
"MatchUserProfile": {
"type": "object",
"properties": {
"ads_brands": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Brand"
}
},
"age_group": {
"title": "Age group",
"type": "string",
"minLength": 1
},
"avg_reels_plays": {
"title": "Avg reels plays",
"description": "",
"type": "integer"
},
"avg_shares": {
"title": "Avg shares",
"type": "integer"
},
"avg_saves": {
"title": "Avg saves",
"type": "integer"
},
"brand_affinity": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Brand"
}
},
"distance": {
"title": "Distance",
"type": "number"
},
"followers_growth": {
"title": "Followers growth",
"type": "number"
},
"gender": {
"title": "Gender",
"type": "string",
"enum": [
"MALE",
"FEMALE"
]
},
"geo": {
"$ref": "#/components/schemas/Geo"
},
"interests": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Interest"
}
},
"language": {
"$ref": "#/components/schemas/Language"
},
"posts_count": {
"title": "Posts count",
"type": "integer"
},
"relevance": {
"title": "Relevance",
"type": "number"
},
"total_likes_growth": {
"title": "Total likes growth",
"type": "number"
},
"total_views_growth": {
"title": "Total views growth",
"type": "number"
}
},
"x-stoplight": {
"id": "q48chyy83i8rm"
}
},
"MatchAudienceData": {
"type": "object",
"properties": {
"audience_likers": {
"$ref": "#/components/schemas/MatchAudience"
},
"user_profile": {
"$ref": "#/components/schemas/MatchUserProfile"
}
},
"x-stoplight": {
"id": "dh7f0sb47yiig"
}
},
"ExportAccount": {
"required": [
"account",
"match"
],
"type": "object",
"properties": {
"account": {
"$ref": "#/components/schemas/ExportAudienceData"
},
"match": {
"$ref": "#/components/schemas/MatchAudienceData"
}
},
"x-stoplight": {
"id": "x40e3p4wjzevs"
}
},
"Country": {
"required": [
"id",
"code"
],
"type": "object",
"properties": {
"id": {
"title": "Id",
"type": "integer"
},
"code": {
"title": "Code",
"type": "string",
"minLength": 1
}
},
"x-stoplight": {
"id": "yl3iukstzxqhh"
}
},
"GeoId": {
"description": "Deprecated",
"required": [
"id"
],
"type": "object",
"properties": {
"id": {
"title": "Id",
"type": "integer"
}
},
"x-stoplight": {
"id": "ofw76qsglp65h"
}
},
"GeoList": {
"required": [
"id",
"type",
"name",
"title"
],
"type": "object",
"properties": {
"id": {
"title": "Id",
"type": "integer"
},
"type": {
"description": "Geo location object type",
"type": "string",
"enum": [
"city",
"subdivision",
"country"
]
},
"name": {
"title": "Name",
"description": "Name of geo location",
"type": "string",
"minLength": 1
},
"title": {
"title": "Title",
"description": "Name of geo location with country name, e.g. \"Paris, France\". For country it is equal to `name`, for cities in US - `name, subdivision, country`",
"type": "string",
"minLength": 1
},
"country": {
"$ref": "#/components/schemas/Country"
},
"subdivision": {
"$ref": "#/components/schemas/Subdivision"
},
"state": {
"$ref": "#/components/schemas/GeoId"
}
},
"x-stoplight": {
"id": "yhuj5jndrj8p4"
}
},
"GeoDetail": {
"required": [
"id",
"type",
"name",
"title"
],
"type": "object",
"properties": {
"id": {
"title": "Id",
"type": "integer"
},
"type": {
"description": "Geo location object type",
"type": "string",
"enum": [
"city",
"subdivision",
"country"
]
},
"name": {
"title": "Name",
"description": "Name of geo location",
"type": "string",
"minLength": 1
},
"title": {
"title": "Title",
"description": "Name of geo location with country name, e.g. \"Paris, France\". For country it is equal to `name`, for cities in US - `name, subdivision, country`",
"type": "string",
"minLength": 1
},
"country": {
"$ref": "#/components/schemas/Country"
},
"subdivision": {
"$ref": "#/components/schemas/Subdivision"
},
"state": {
"$ref": "#/components/schemas/GeoId"
},
"coords": {
"$ref": "#/components/schemas/Coords"
}
},
"x-stoplight": {
"id": "0gy1b7b25mtc0"
}
},
"RequestHistoryExport": {
"required": [
"platform",
"done_at",
"feature",
"origin"
],
"type": "object",
"properties": {
"ip": {
"title": "Ip",
"type": "string",
"readOnly": true
},
"meta": {
"title": "Meta",
"type": "object",
"readOnly": true,
"nullable": true
},
"query_string": {
"title": "Query string",
"type": "string",
"readOnly": true,
"nullable": true
},
"request_body": {
"title": "Request body",
"type": "object",
"readOnly": true,
"nullable": true
},
"response_status": {
"title": "Response status",
"type": "integer",
"readOnly": true
},
"platform": {
"title": "Platform",
"type": "string",
"enum": [
"instagram",
"tiktok",
"youtube"
]
},
"done_at": {
"title": "Done at",
"type": "string",
"format": "date-time"
},
"feature": {
"title": "Feature",
"type": "string",
"maxLength": 50,
"minLength": 1
},
"cost": {
"title": "Cost",
"type": "number",
"format": "decimal",
"nullable": true
},
"quota": {
"title": "Quota",
"type": "integer",
"maximum": 2147483647,
"minimum": -2147483648,
"nullable": true
},
"origin": {
"title": "Origin",
"type": "string",
"enum": [
"api",
"wla",
"web"
]
}
},
"x-stoplight": {
"id": "3ud17n79ffovp"
}
},
"List": {
"required": [
"id",
"type",
"max_size",
"size",
"platform"
],
"type": "object",
"properties": {
"id": {
"title": "Id",
"type": "integer"
},
"type": {
"title": "Type",
"type": "string",
"enum": [
"exported",
"shown",
"ad_updates",
"custom"
]
},
"max_size": {
"title": "Max size",
"type": "integer"
},
"size": {
"title": "Size",
"type": "integer"
},
"platform": {
"title": "Platform",
"type": "string",
"minLength": 1
}
},
"x-stoplight": {
"id": "82c6puw4mf9g2"
}
},
"ListsListResponse": {
"required": [
"success",
"data"
],
"type": "object",
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/List"
}
}
},
"x-stoplight": {
"id": "vvy6y0qjxi4u0"
}
},
"ListAccount": {
"required": [
"user_id",
"created_at",
"remove_at"
],
"type": "object",
"properties": {
"user_id": {
"title": "User id",
"type": "string",
"minLength": 1
},
"created_at": {
"title": "Created at",
"type": "string",
"format": "date-time"
},
"remove_at": {
"title": "Remove at",
"description": "If not null then this account is marked for removal but not actually removed from the list. It be will be in severals seconds. It rare cases in can take several minutes.",
"type": "string",
"format": "date-time",
"nullable": true
}
},
"x-stoplight": {
"id": "utndibgkf6slb"
}
},
"ListResponse": {
"required": [
"success",
"data"
],
"type": "object",
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ListAccount"
}
}
},
"x-stoplight": {
"id": "xefmagsszw1fp"
}
},
"UserIdsList": {
"type": "object",
"properties": {
"user_ids": {
"description": "No more than 10000 IDs at once",
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
}
},
"x-stoplight": {
"id": "2e1anx8i38a2f"
}
},
"ListsStatisticsResponse": {
"required": [
"success",
"custom_lists_created",
"custom_lists_remaining"
],
"type": "object",
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"custom_lists_created": {
"title": "Custom lists created",
"type": "integer"
},
"custom_lists_remaining": {
"title": "Custom lists remaining",
"type": "integer"
}
},
"x-stoplight": {
"id": "08v3afvxfflj3"
}
},
"MarketScanFilterCreatedRange": {
"description": "Range of posts created at, as UNIX timestamp.",
"type": "object",
"properties": {
"left_number": {
"title": "Left number",
"type": "integer"
},
"right_number": {
"title": "Right number",
"type": "integer"
}
},
"x-stoplight": {
"id": "w8nn2h2bsxl7u"
}
},
"MarketScanFilterFollowersRange": {
"description": "Range of posts creator number of followers at the current moment",
"type": "object",
"properties": {
"left_number": {
"title": "Left number",
"type": "integer"
},
"right_number": {
"title": "Right number",
"type": "integer"
}
},
"x-stoplight": {
"id": "awfmpg92nwr8e"
}
},
"MarketScanFilterLikesRange": {
"description": "Range of likes post gained at the current moment",
"type": "object",
"properties": {
"left_number": {
"title": "Left number",
"type": "integer"
},
"right_number": {
"title": "Right number",
"type": "integer"
}
},
"x-stoplight": {
"id": "1ccy9k1hax7rw"
}
},
"MarketScanSearchFilters": {
"type": "object",
"properties": {
"created_at": {
"$ref": "#/components/schemas/MarketScanFilterCreatedRange"
},
"followers": {
"$ref": "#/components/schemas/MarketScanFilterFollowersRange"
},
"likes": {
"$ref": "#/components/schemas/MarketScanFilterLikesRange"
},
"geo": {
"$ref": "#/components/schemas/FilterGeo"
},
"has_sponsor": {
"title": "Has sponsor",
"description": "Filter posts which has official \"Paid partnership\" tag",
"type": "boolean"
},
"sponsor_username": {
"title": "Sponsor username",
"description": "Filter posts with official \"Paid partnership\" tag to specific user",
"type": "string",
"minLength": 1
},
"hashtags": {
"description": "Filter posts using specific hashtags",
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
},
"mentions": {
"description": "Filter posts mentioning specific accounts in the text, on an image, or using paid partnership tag.",
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
},
"brands": {
"description": "Filter posts mentioning specific brands (taged tagging in text, on an image or paid partnership)",
"type": "array",
"items": {
"type": "integer"
}
}
},
"x-stoplight": {
"id": "0wxkdj06vxuq0"
}
},
"SearchPaging": {
"required": [
"limit"
],
"type": "object",
"properties": {
"limit": {
"title": "Limit",
"type": "integer",
"maximum": 100
},
"skip": {
"title": "Skip",
"description": "limit+skip must be less or equal than 10,000. To get more use Data Export.",
"type": "integer",
"default": 0
}
},
"x-stoplight": {
"id": "prmm5960jkc3y"
}
},
"MarketScanPostsSearchRequest": {
"required": [
"filter",
"paging"
],
"type": "object",
"properties": {
"filter": {
"$ref": "#/components/schemas/MarketScanSearchFilters"
},
"paging": {
"$ref": "#/components/schemas/SearchPaging"
}
},
"x-stoplight": {
"id": "69ph4m9pu27h1"
}
},
"UserBasicStats": {
"description": "",
"type": "object",
"properties": {
"post_type": {
"title": "Post type",
"description": " - `all`, `reels`\n\n - `all`\n\n - `all`, `videos`, `shorts`, `streams`",
"type": "string",
"enum": [
"all",
"reels",
"videos",
"shorts",
"streams"
]
},
"engagements": {
"title": "Engagements",
"description": "",
"type": "integer"
},
"avg_likes": {
"title": "Avg likes",
"description": "",
"type": "integer"
},
"avg_views": {
"title": "Avg views",
"description": "",
"type": "integer"
}
},
"x-stoplight": {
"id": "8tns9yg3afb0x"
}
},
"MarketScanUserInfo": {
"required": [
"user_id",
"picture",
"followers",
"url",
"is_verified",
"followers_at_time_of_post"
],
"type": "object",
"properties": {
"user_id": {
"title": "User id",
"type": "string",
"minLength": 1
},
"username": {
"title": "Username",
"type": "string",
"minLength": 1
},
"custom_name": {
"title": "Custom name",
"description": "",
"type": "string",
"minLength": 1
},
"picture": {
"title": "Picture",
"type": "string",
"minLength": 1
},
"followers": {
"title": "Followers",
"type": "integer"
},
"fullname": {
"title": "Fullname",
"type": "string",
"minLength": 1
},
"url": {
"title": "Url",
"type": "string",
"minLength": 1
},
"geo": {
"$ref": "#/components/schemas/Geo"
},
"is_verified": {
"title": "Is verified",
"type": "boolean"
},
"engagements": {
"title": "Engagements",
"type": "integer"
},
"avg_likes": {
"title": "Avg likes",
"type": "integer"
},
"avg_comments": {
"title": "Avg comments",
"type": "integer"
},
"avg_views": {
"title": "Avg views",
"description": "",
"type": "integer"
},
"stats": {
"description": "",
"type": "array",
"items": {
"$ref": "#/components/schemas/UserBasicStats"
}
},
"followers_at_time_of_post": {
"title": "Followers at time of post",
"type": "integer"
}
},
"x-stoplight": {
"id": "bbujuyk9vtsyi"
}
},
"PostStat": {
"required": [
"likes"
],
"type": "object",
"properties": {
"likes": {
"title": "Likes",
"type": "integer"
},
"comments": {
"title": "Comments",
"type": "integer"
},
"views": {
"title": "Views",
"description": "",
"type": "integer"
},
"plays": {
"title": "Plays",
"description": "",
"type": "integer"
},
"shares": {
"title": "Shares",
"description": "",
"type": "integer"
},
"saves": {
"title": "Saves",
"description": "",
"type": "integer"
}
},
"x-stoplight": {
"id": "k37yqlbdefwps"
}
},
"Sponsor": {
"required": [
"user_id",
"username"
],
"type": "object",
"properties": {
"user_id": {
"title": "User id",
"type": "string",
"minLength": 1
},
"username": {
"title": "Username",
"type": "string",
"minLength": 1
}
},
"x-stoplight": {
"id": "al0ux3i9y3u5e"
}
},
"MarketScanPostInfo": {
"required": [
"created",
"type",
"user",
"text",
"link",
"thumbnail",
"stat"
],
"type": "object",
"properties": {
"created": {
"title": "Created",
"type": "string",
"format": "date-time"
},
"type": {
"title": "Type",
"type": "string",
"enum": [
"image",
"video"
]
},
"user": {
"$ref": "#/components/schemas/MarketScanUserInfo"
},
"text": {
"title": "Text",
"type": "string",
"minLength": 1
},
"link": {
"title": "Link",
"type": "string",
"minLength": 1
},
"thumbnail": {
"title": "Thumbnail",
"type": "string",
"minLength": 1
},
"image": {
"title": "Image",
"type": "string",
"minLength": 1
},
"video": {
"title": "Video",
"type": "string",
"minLength": 1
},
"stat": {
"$ref": "#/components/schemas/PostStat"
},
"mentions": {
"description": "Union of photo_metions and text_mentions",
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
},
"photo_mentions": {
"description": "Mention tags from text posts photos",
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
},
"text_mentions": {
"description": "Mention tags from the post text",
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
},
"hashtags": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
},
"sponsor": {
"$ref": "#/components/schemas/Sponsor"
}
},
"x-stoplight": {
"id": "ix56yno30uu5b"
}
},
"MarketScanSearchResponse": {
"required": [
"total",
"posts"
],
"type": "object",
"properties": {
"total": {
"title": "Total",
"type": "integer"
},
"posts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MarketScanPostInfo"
}
}
},
"x-stoplight": {
"id": "ex167v964st5q"
}
},
"MarketScanSearchSort": {
"required": [
"field"
],
"type": "object",
"properties": {
"field": {
"title": "Field",
"type": "string",
"enum": [
"count",
"likes"
]
},
"direction": {
"title": "Direction",
"type": "string",
"enum": [
"desc"
],
"default": "desc"
}
},
"x-stoplight": {
"id": "f7611dg6ftdz1"
}
},
"MarketScanSearchRequest": {
"required": [
"filter",
"sort"
],
"type": "object",
"properties": {
"filter": {
"$ref": "#/components/schemas/MarketScanSearchFilters"
},
"sort": {
"$ref": "#/components/schemas/MarketScanSearchSort"
}
},
"x-stoplight": {
"id": "o0eju9medpn65"
}
},
"MarketScanTopItem": {
"required": [
"value",
"count",
"followers",
"likes",
"accounts"
],
"type": "object",
"properties": {
"value": {
"title": "Value",
"type": "string",
"minLength": 1
},
"count": {
"title": "Count",
"type": "integer"
},
"followers": {
"title": "Followers",
"type": "integer"
},
"likes": {
"title": "Likes",
"type": "integer"
},
"accounts": {
"title": "Accounts",
"type": "integer"
}
},
"x-stoplight": {
"id": "07i3lszx8f40d"
}
},
"MarketScanTopResponseData": {
"required": [
"top"
],
"type": "object",
"properties": {
"top": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MarketScanTopItem"
}
}
},
"x-stoplight": {
"id": "t2k2euzu28120"
}
},
"MarketScanTopResponse": {
"required": [
"data"
],
"type": "object",
"properties": {
"success": {
"title": "Success",
"type": "boolean",
"default": false
},
"data": {
"$ref": "#/components/schemas/MarketScanTopResponseData"
}
},
"x-stoplight": {
"id": "ysea1121hypni"
}
},
"MatchEmailsRequest": {
"required": [
"emails"
],
"type": "object",
"properties": {
"emails": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"maxItems": 1000,
"minItems": 1
},
"ignore_agency_emails": {
"title": "Ignore agency emails",
"description": "If true, filters out emails marked as might_be_agency=true. Emails are marked as such when the same email is found across more than 10 creators.",
"type": "boolean",
"default": true
}
},
"x-stoplight": {
"id": "avhno98vskad7"
}
},
"UserByEmail": {
"required": [
"type",
"user_id",
"url",
"picture"
],
"type": "object",
"properties": {
"type": {
"title": "Type",
"type": "string",
"enum": [
"instagram",
"tiktok",
"youtube"
]
},
"user_id": {
"title": "User id",
"type": "string",
"minLength": 1
},
"url": {
"title": "Url",
"type": "string",
"minLength": 1
},
"username": {
"title": "Username",
"type": "string",
"minLength": 1
},
"custom_name": {
"title": "Custom name",
"description": "",
"type": "string",
"minLength": 1
},
"fullname": {
"title": "Fullname",
"type": "string"
},
"picture": {
"title": "Picture",
"type": "string",
"minLength": 1
},
"followers": {
"title": "Followers",
"type": "integer"
},
"engagements": {
"title": "Engagements",
"type": "integer"
},
"engagement_rate": {
"title": "Engagement rate",
"type": "number"
},
"is_verified": {
"title": "Is verified",
"type": "boolean"
}
},
"x-stoplight": {
"id": "2wbtntha82jzy"
}
},
"MatchedEmail": {
"required": [
"email",
"users"
],
"type": "object",
"properties": {
"email": {
"title": "Email",
"type": "string",
"minLength": 1
},
"users": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserByEmail"
}
}
},
"x-stoplight": {
"id": "g4bnexayehpjh"
}
},
"MatchEmailsResponse": {
"required": [
"success",
"matched_count"
],
"type": "object",
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"matched_count": {
"title": "Matched count",
"type": "integer",
"minimum": 0
},
"matched_emails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MatchedEmail"
}
},
"not_matched_emails": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
}
},
"x-stoplight": {
"id": "6jnmub8dd146u"
}
},
"InstagramUserInfoPostImageVersionCandidate": {
"required": [
"width",
"height",
"url"
],
"type": "object",
"properties": {
"width": {
"title": "Width",
"type": "integer"
},
"height": {
"title": "Height",
"type": "integer"
},
"url": {
"title": "Url",
"type": "string",
"minLength": 1
},
"scans_profile": {
"title": "Scans profile",
"type": "string",
"nullable": true
}
},
"x-stoplight": {
"id": "v0itfdci8chs2"
}
},
"InstagramUserInfoPostImageVersion": {
"required": [
"candidates"
],
"type": "object",
"properties": {
"candidates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InstagramUserInfoPostImageVersionCandidate"
}
}
},
"x-stoplight": {
"id": "yfo9e8witopwm"
}
},
"InstagramUserPreviewInfo": {
"required": [
"pk",
"username"
],
"type": "object",
"properties": {
"pk": {
"title": "Pk",
"type": "integer"
},
"pk_id": {
"title": "Pk id",
"type": "string",
"minLength": 1
},
"username": {
"title": "Username",
"type": "string"
},
"full_name": {
"title": "Full name",
"type": "string"
},
"profile_pic_url": {
"title": "Profile pic url",
"type": "string",
"minLength": 1
},
"is_private": {
"title": "Is private",
"type": "boolean"
},
"is_verified": {
"title": "Is verified",
"type": "boolean"
}
},
"x-stoplight": {
"id": "sk46mwa2a903q"
}
},
"InstagramUserInfoPostUserTagsIn": {
"required": [
"user"
],
"type": "object",
"properties": {
"user": {
"$ref": "#/components/schemas/InstagramUserPreviewInfo"
},
"position": {
"type": "array",
"items": {
"type": "number"
}
}
},
"x-stoplight": {
"id": "4uefnopsbucaw"
}
},
"InstagramUserInfoPostUserTags": {
"required": [
"in"
],
"type": "object",
"properties": {
"in": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InstagramUserInfoPostUserTagsIn"
}
}
},
"x-stoplight": {
"id": "4uuq6l24cz0d1"
}
},
"InstagramUserInfoPostCaption": {
"required": [
"text"
],
"type": "object",
"properties": {
"text": {
"title": "Text",
"type": "string",
"nullable": true
}
},
"nullable": true,
"x-stoplight": {
"id": "y7kkfdbzlv2gc"
}
},
"InstagramCoauthorUserInfo": {
"required": [
"pk",
"username"
],
"type": "object",
"properties": {
"pk": {
"title": "Pk",
"type": "integer"
},
"is_verified": {
"title": "Is verified",
"type": "boolean"
},
"profile_pic_url": {
"title": "Profile pic url",
"type": "string",
"minLength": 1
},
"username": {
"title": "Username",
"type": "string"
}
},
"nullable": true,
"x-stoplight": {
"id": "f8ppbct9wt9ak"
}
},
"InstagramUserInfoPostLocation": {
"required": [
"pk"
],
"type": "object",
"properties": {
"pk": {
"title": "Pk",
"type": "integer"
},
"name": {
"title": "Name",
"type": "string"
},
"lng": {
"title": "Lng",
"type": "number"
},
"lat": {
"title": "Lat",
"type": "number"
},
"address": {
"title": "Address",
"type": "string",
"nullable": true
},
"city": {
"title": "City",
"type": "string",
"nullable": true
}
},
"x-stoplight": {
"id": "27eg8apz8h139"
}
},
"InstagramPostSponsorItem": {
"type": "object",
"properties": {
"sponsor": {
"$ref": "#/components/schemas/InstagramUserPreviewInfo"
}
},
"nullable": true,
"x-stoplight": {
"id": "qia502b2m48jm"
}
},
"InstagramPostCarouselMedia": {
"required": [
"pk",
"display_url"
],
"type": "object",
"properties": {
"pk": {
"title": "Pk",
"type": "integer"
},
"display_url": {
"title": "Display url",
"type": "string"
},
"image_versions2": {
"$ref": "#/components/schemas/InstagramUserInfoPostImageVersion"
},
"has_audio": {
"title": "Has audio",
"type": "boolean"
},
"is_dash_eligible": {
"title": "Is dash eligible",
"type": "string",
"minLength": 1
},
"video_dash_manifest": {
"title": "Video dash manifest",
"type": "string",
"minLength": 1,
"nullable": true
},
"number_of_qualities": {
"title": "Number of qualities",
"type": "integer"
},
"video_url": {
"title": "Video url",
"type": "string",
"readOnly": true,
"nullable": true
},
"video_subtitles_uri": {
"title": "Video subtitles uri",
"type": "string",
"nullable": true
},
"video_subtitles_locale": {
"title": "Video subtitles locale",
"type": "string",
"nullable": true
},
"usertags": {
"$ref": "#/components/schemas/InstagramUserInfoPostUserTags"
}
},
"x-stoplight": {
"id": "510t0wg0bgyx5"
}
},
"InstagramMusicInfoMusicAssetInfo": {
"required": [
"audio_asset_id",
"audio_cluster_id",
"id",
"title",
"subtitle",
"display_artist",
"cover_artwork_uri",
"cover_artwork_thumbnail_uri",
"progressive_download_url",
"fast_start_progressive_download_url",
"duration_in_ms"
],
"type": "object",
"properties": {
"audio_asset_id": {
"title": "Audio asset id",
"type": "string",
"minLength": 1
},
"audio_cluster_id": {
"title": "Audio cluster id",
"type": "string",
"nullable": true
},
"id": {
"title": "Id",
"type": "string",
"minLength": 1
},
"title": {
"title": "Title",
"type": "string",
"nullable": true
},
"sanitized_title": {
"title": "Sanitized title",
"type": "string",
"nullable": true
},
"subtitle": {
"title": "Subtitle",
"type": "string",
"nullable": true
},
"display_artist": {
"title": "Display artist",
"type": "string",
"nullable": true
},
"artist_id": {
"title": "Artist id",
"type": "string",
"nullable": true
},
"is_explicit": {
"title": "Is explicit",
"type": "boolean"
},
"cover_artwork_uri": {
"title": "Cover artwork uri",
"type": "string",
"nullable": true
},
"cover_artwork_thumbnail_uri": {
"title": "Cover artwork thumbnail uri",
"type": "string",
"nullable": true
},
"progressive_download_url": {
"title": "Progressive download url",
"type": "string",
"nullable": true
},
"reactive_audio_download_url": {
"title": "Reactive audio download url",
"type": "string",
"nullable": true
},
"fast_start_progressive_download_url": {
"title": "Fast start progressive download url",
"type": "string",
"nullable": true
},
"web_30s_preview_download_url": {
"title": "Web 30s preview download url",
"type": "string",
"nullable": true
},
"highlight_start_times_in_ms": {
"type": "array",
"items": {
"type": "integer"
}
},
"has_lyrics": {
"title": "Has lyrics",
"type": "boolean"
},
"duration_in_ms": {
"title": "Duration in ms",
"type": "integer"
},
"dark_message": {
"title": "Dark message",
"type": "string",
"nullable": true
},
"ig_username": {
"title": "Ig username",
"type": "string",
"nullable": true
},
"is_eligible_for_audio_effects": {
"title": "Is eligible for audio effects",
"type": "boolean",
"nullable": true
},
"ig_artist": {
"$ref": "#/components/schemas/InstagramUserPreviewInfo"
},
"placeholder_profile_pic_url": {
"title": "Placeholder profile pic url",
"type": "string",
"nullable": true
},
"overlap_duration_in_ms": {
"title": "Overlap duration in ms",
"type": "integer"
},
"audio_asset_start_time_in_ms": {
"title": "Audio asset start time in ms",
"type": "integer"
},
"is_trending_in_clips": {
"title": "Is trending in clips",
"type": "boolean"
},
"formatted_clips_media_count": {
"title": "Formatted clips media count",
"type": "integer",
"nullable": true
},
"should_render_soundwave": {
"title": "Should render soundwave",
"type": "boolean"
}
},
"nullable": true,
"x-stoplight": {
"id": "6icy7ft2gyijq"
}
},
"InstagramClipsMetadataMusicInfo": {
"type": "object",
"properties": {
"music_asset_info": {
"$ref": "#/components/schemas/InstagramMusicInfoMusicAssetInfo"
}
},
"nullable": true,
"x-stoplight": {
"id": "9mijoafai1z63"
}
},
"InstagramPostClipsMetadata": {
"type": "object",
"properties": {
"music_info": {
"$ref": "#/components/schemas/InstagramClipsMetadataMusicInfo"
}
},
"nullable": true,
"x-stoplight": {
"id": "jktiz0vq4s79z"
}
},
"InstagramPostMusicMetadata": {
"type": "object",
"properties": {
"music_info": {
"$ref": "#/components/schemas/InstagramClipsMetadataMusicInfo"
}
},
"nullable": true,
"x-stoplight": {
"id": "cchnqr70ym9x7"
}
},
"InstagramPostData": {
"required": [
"pk",
"display_url",
"taken_at",
"code",
"media_type",
"user"
],
"type": "object",
"properties": {
"pk": {
"title": "Pk",
"type": "integer"
},
"display_url": {
"title": "Display url",
"type": "string"
},
"image_versions2": {
"$ref": "#/components/schemas/InstagramUserInfoPostImageVersion"
},
"has_audio": {
"title": "Has audio",
"type": "boolean"
},
"is_dash_eligible": {
"title": "Is dash eligible",
"type": "string",
"minLength": 1
},
"video_dash_manifest": {
"title": "Video dash manifest",
"type": "string",
"minLength": 1,
"nullable": true
},
"number_of_qualities": {
"title": "Number of qualities",
"type": "integer"
},
"video_url": {
"title": "Video url",
"type": "string",
"readOnly": true,
"nullable": true
},
"video_subtitles_uri": {
"title": "Video subtitles uri",
"type": "string",
"nullable": true
},
"video_subtitles_locale": {
"title": "Video subtitles locale",
"type": "string",
"nullable": true
},
"usertags": {
"$ref": "#/components/schemas/InstagramUserInfoPostUserTags"
},
"taken_at": {
"title": "Taken at",
"type": "integer"
},
"code": {
"title": "Code",
"type": "string",
"minLength": 1
},
"comment_count": {
"title": "Comment count",
"type": "integer"
},
"like_count": {
"title": "Like count",
"type": "integer"
},
"fb_like_count": {
"title": "Fb like count",
"type": "integer"
},
"view_count": {
"title": "View count",
"type": "integer"
},
"play_count": {
"title": "Play count",
"type": "integer",
"nullable": true
},
"ig_play_count": {
"title": "Ig play count",
"type": "integer"
},
"fb_play_count": {
"title": "Fb play count",
"type": "integer"
},
"fb_comment_count": {
"title": "Fb comment count",
"type": "integer"
},
"like_and_view_counts_disabled": {
"title": "Like and view counts disabled",
"type": "boolean"
},
"media_type": {
"title": "Media type",
"description": "```0``` - clips, ```1``` - photo, ```2``` - video, ```8``` - carousel, ```13``` - guide",
"type": "integer",
"enum": [
0,
1,
2,
8,
13
]
},
"video_duration": {
"title": "Video duration",
"type": "number"
},
"caption": {
"$ref": "#/components/schemas/InstagramUserInfoPostCaption"
},
"title": {
"title": "Title",
"type": "string",
"nullable": true
},
"user": {
"$ref": "#/components/schemas/InstagramUserPreviewInfo"
},
"coauthor_producers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InstagramCoauthorUserInfo"
},
"nullable": true
},
"location": {
"$ref": "#/components/schemas/InstagramUserInfoPostLocation"
},
"product_type": {
"title": "Product type",
"description": "Known values: ```\"feed\"```, ```\"carousel_container\"```, ```\"carousel_item\"```, ```\"igtv\"```, ```\"clips\"```, ```\"ad\"```, ```\"story\"```, ```\"guide_media_facade\"```",
"type": "string"
},
"timeline_pinned_user_ids": {
"type": "array",
"items": {
"type": "integer"
}
},
"can_viewer_reshare": {
"title": "Can viewer reshare",
"type": "boolean"
},
"reshare_count": {
"title": "Reshare count",
"type": "integer"
},
"is_paid_partnership": {
"title": "Is paid partnership",
"type": "boolean"
},
"sponsor_tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InstagramPostSponsorItem"
},
"nullable": true
},
"carousel_media_count": {
"title": "Carousel media count",
"type": "integer"
},
"carousel_media": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InstagramPostCarouselMedia"
}
},
"clips_metadata": {
"$ref": "#/components/schemas/InstagramPostClipsMetadata"
},
"music_metadata": {
"$ref": "#/components/schemas/InstagramPostMusicMetadata"
}
},
"nullable": true,
"x-stoplight": {
"id": "87luj644b7tfb"
}
},
"InstagramAudioFeedItem": {
"type": "object",
"properties": {
"media": {
"$ref": "#/components/schemas/InstagramPostData"
}
},
"x-stoplight": {
"id": "o0rhda3pdl6l1"
}
},
"MusicAssetInfo": {
"type": "object",
"properties": {
"allows_saving": {
"title": "Allows saving",
"type": "boolean",
"nullable": true
},
"artist_id": {
"title": "Artist id",
"type": "string",
"nullable": true
},
"audio_asset_id": {
"title": "Audio asset id",
"type": "string",
"nullable": true
},
"audio_cluster_id": {
"title": "Audio cluster id",
"type": "string",
"nullable": true
},
"cover_artwork_thumbnail_uri": {
"title": "Cover artwork thumbnail uri",
"type": "string",
"nullable": true
},
"cover_artwork_uri": {
"title": "Cover artwork uri",
"type": "string",
"nullable": true
},
"dash_manifest": {
"title": "Dash manifest",
"type": "string",
"nullable": true
},
"display_artist": {
"title": "Display artist",
"type": "string",
"nullable": true
},
"duration_in_ms": {
"title": "Duration in ms",
"type": "integer",
"nullable": true
},
"fast_start_progressive_download_url": {
"title": "Fast start progressive download url",
"type": "string",
"nullable": true
},
"has_lyrics": {
"title": "Has lyrics",
"type": "boolean",
"nullable": true
},
"highlight_start_times_in_ms": {
"type": "array",
"items": {
"type": "integer"
},
"nullable": true
},
"id": {
"title": "Id",
"type": "string",
"nullable": true
},
"ig_username": {
"title": "Ig username",
"type": "string",
"nullable": true
},
"is_eligible_for_audio_effects": {
"title": "Is eligible for audio effects",
"type": "boolean",
"nullable": true
},
"is_explicit": {
"title": "Is explicit",
"type": "boolean",
"nullable": true
},
"progressive_download_url": {
"title": "Progressive download url",
"type": "string",
"nullable": true
},
"reactive_audio_download_url": {
"title": "Reactive audio download url",
"type": "string",
"nullable": true
},
"sanitized_title": {
"title": "Sanitized title",
"type": "string",
"nullable": true
},
"subtitle": {
"title": "Subtitle",
"type": "string",
"nullable": true
},
"title": {
"title": "Title",
"type": "string",
"nullable": true
},
"web_30s_preview_download_url": {
"title": "Web 30s preview download url",
"type": "string",
"nullable": true
},
"is_eligible_for_vinyl_sticker": {
"title": "Is eligible for vinyl sticker",
"type": "boolean",
"nullable": true
},
"lyrics": {
"title": "Lyrics",
"type": "string",
"nullable": true
}
},
"nullable": true,
"x-stoplight": {
"id": "87l5qzz5hx1h6"
}
},
"IGArtist": {
"type": "object",
"properties": {
"pk": {
"title": "Pk",
"type": "string",
"nullable": true
},
"pk_id": {
"title": "Pk id",
"type": "string",
"nullable": true
},
"id": {
"title": "Id",
"type": "string",
"nullable": true
},
"username": {
"title": "Username",
"type": "string",
"nullable": true
},
"full_name": {
"title": "Full name",
"type": "string",
"nullable": true
},
"is_private": {
"title": "Is private",
"type": "boolean",
"nullable": true
},
"is_verified": {
"title": "Is verified",
"type": "boolean",
"nullable": true
},
"profile_pic_id": {
"title": "Profile pic id",
"type": "string",
"nullable": true
},
"profile_pic_url": {
"title": "Profile pic url",
"type": "string",
"nullable": true
}
},
"nullable": true,
"x-stoplight": {
"id": "uqaeqk3paoym7"
}
},
"MusicConsumptionInfo": {
"type": "object",
"properties": {
"allow_media_creation_with_music": {
"title": "Allow media creation with music",
"type": "boolean",
"nullable": true
},
"audio_asset_start_time_in_ms": {
"title": "Audio asset start time in ms",
"type": "integer",
"nullable": true
},
"contains_lyrics": {
"title": "Contains lyrics",
"type": "boolean",
"nullable": true
},
"formatted_clips_media_count": {
"title": "Formatted clips media count",
"type": "string",
"nullable": true
},
"ig_artist": {
"$ref": "#/components/schemas/IGArtist"
},
"is_bookmarked": {
"title": "Is bookmarked",
"type": "boolean",
"nullable": true
},
"is_trending_in_clips": {
"title": "Is trending in clips",
"type": "boolean",
"nullable": true
},
"overlap_duration_in_ms": {
"title": "Overlap duration in ms",
"type": "integer",
"nullable": true
},
"should_allow_music_editing": {
"title": "Should allow music editing",
"type": "boolean",
"nullable": true
},
"should_mute_audio": {
"title": "Should mute audio",
"type": "boolean",
"nullable": true
}
},
"nullable": true,
"x-stoplight": {
"id": "yv8en45pqa25u"
}
},
"MusicInfo": {
"type": "object",
"properties": {
"music_canonical_id": {
"title": "Music canonical id",
"type": "string",
"nullable": true
},
"music_asset_info": {
"$ref": "#/components/schemas/MusicAssetInfo"
},
"music_consumption_info": {
"$ref": "#/components/schemas/MusicConsumptionInfo"
}
},
"nullable": true,
"x-stoplight": {
"id": "w3flhift9jziy"
}
},
"MusicMetadata": {
"type": "object",
"properties": {
"music_info": {
"$ref": "#/components/schemas/MusicInfo"
},
"original_sound_info": {
"title": "Original sound info",
"type": "object",
"nullable": true
},
"creative_config_info": {
"title": "Creative config info",
"type": "object",
"nullable": true
},
"additional_audio_info": {
"title": "Additional audio info",
"type": "object",
"nullable": true
}
},
"nullable": true,
"x-stoplight": {
"id": "a049iuroea302"
}
},
"AudioRankingInfo": {
"type": "object",
"properties": {
"best_audio_cluster_id": {
"title": "Best audio cluster id",
"type": "string",
"minLength": 1,
"nullable": true
}
},
"nullable": true,
"x-stoplight": {
"id": "c3va0po84w6pi"
}
},
"MediaCount": {
"type": "object",
"properties": {
"clips_count": {
"title": "Clips count",
"type": "integer",
"nullable": true
},
"photos_count": {
"title": "Photos count",
"type": "integer",
"nullable": true
}
},
"nullable": true,
"x-stoplight": {
"id": "hk7aaqx8d19rx"
}
},
"InstagramAudioFeed": {
"required": [
"status"
],
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InstagramAudioFeedItem"
}
},
"music_canonical_id": {
"title": "Music canonical id",
"type": "string",
"minLength": 1,
"nullable": true
},
"audio_page_reporting_id": {
"title": "Audio page reporting id",
"type": "string",
"minLength": 1,
"nullable": true
},
"formatted_media_count": {
"title": "Formatted media count",
"type": "string",
"nullable": true
},
"metadata": {
"$ref": "#/components/schemas/MusicMetadata"
},
"audio_ranking_info": {
"$ref": "#/components/schemas/AudioRankingInfo"
},
"is_music_page_restricted": {
"title": "Is music page restricted",
"type": "boolean",
"nullable": true
},
"audio_page_segments": {
"type": "array",
"items": {
"type": "object"
},
"nullable": true
},
"available_tabs": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"nullable": true
},
"media_count": {
"$ref": "#/components/schemas/MediaCount"
},
"auto_created_reels_preview_metadata": {
"type": "array",
"items": {
"type": "object"
},
"nullable": true
},
"status": {
"title": "Status",
"type": "string",
"enum": [
"ok",
"fail"
]
},
"end_cursor": {
"title": "End cursor",
"type": "string",
"readOnly": true,
"nullable": true
}
},
"x-stoplight": {
"id": "39aen7n35jm9z"
}
},
"InstagramTagFeed": {
"required": [
"status"
],
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InstagramPostData"
}
},
"more_available": {
"title": "More available",
"type": "boolean"
},
"end_cursor": {
"title": "End cursor",
"type": "string",
"readOnly": true,
"nullable": true
},
"status": {
"title": "Status",
"type": "string",
"enum": [
"ok",
"fail"
]
}
},
"x-stoplight": {
"id": "9rn3efuw8sayn"
}
},
"InstagramTagInfo": {
"required": [
"id",
"name",
"media_count",
"status"
],
"type": "object",
"properties": {
"id": {
"title": "Id",
"type": "integer"
},
"name": {
"title": "Name",
"type": "string",
"minLength": 1
},
"media_count": {
"title": "Media count",
"type": "integer"
},
"status": {
"title": "Status",
"type": "string",
"enum": [
"ok",
"fail"
]
}
},
"x-stoplight": {
"id": "9mqbt8f1vj0u7"
}
},
"InstagramHighlightReelsHighlightCoverMedia": {
"type": "object",
"properties": {
"cropped_image_version": {
"$ref": "#/components/schemas/InstagramUserInfoPostImageVersionCandidate"
},
"crop_rect": {
"type": "array",
"items": {
"type": "number"
},
"nullable": true
},
"media_id": {
"title": "Media id",
"type": "string",
"nullable": true
}
},
"x-stoplight": {
"id": "nwc8acoz1uhk8"
}
},
"InstagramHighlightReelsHighlightItemsItemVideoVersionsItem": {
"type": "object",
"properties": {
"bandwidth": {
"title": "Bandwidth",
"type": "integer"
},
"height": {
"title": "Height",
"type": "integer"
},
"id": {
"title": "Id",
"type": "string"
},
"type": {
"title": "Type",
"type": "integer"
},
"url": {
"title": "Url",
"type": "string"
},
"width": {
"title": "Width",
"type": "integer"
}
},
"x-stoplight": {
"id": "0tkae0767ix8l"
}
},
"InstagramHighlightReelsHighlightItemsItemFundraiserTag": {
"type": "object",
"properties": {
"has_standalone_fundraiser": {
"title": "Has standalone fundraiser",
"type": "boolean"
}
},
"x-stoplight": {
"id": "ac75qyjyjecqq"
}
},
"InstagramHighlightReelsHighlightItemsItemHighlightsInfoSerializerAddedToItem": {
"type": "object",
"properties": {
"reel_id": {
"title": "Reel id",
"type": "string"
},
"title": {
"title": "Title",
"type": "string"
}
},
"x-stoplight": {
"id": "rbx7zzpdho3jl"
}
},
"InstagramHighlightReelsHighlightItemsItemHighlightsInfo": {
"type": "object",
"properties": {
"added_to": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InstagramHighlightReelsHighlightItemsItemHighlightsInfoSerializerAddedToItem"
}
}
},
"x-stoplight": {
"id": "unnmrraa6q8k4"
}
},
"InstagramHighlightReelsHighlightItemsItemUser": {
"type": "object",
"properties": {
"pk": {
"title": "Pk",
"type": "string"
},
"is_private": {
"title": "Is private",
"type": "boolean"
},
"id": {
"title": "Id",
"type": "string"
},
"strong_id__": {
"title": "Strong id ",
"type": "string"
}
},
"x-stoplight": {
"id": "lngqvepi2x1c2"
}
},
"FbDownstreamUseXpostMetadata": {
"type": "object",
"properties": {
"downstream_use_xpost_deny_reason": {
"title": "Downstream use xpost deny reason",
"type": "string"
}
},
"x-stoplight": {
"id": "uvdf996jpaz7v"
}
},
"InstagramHighlightReelsHighlightItemsItemCrosspostMetadata": {
"type": "object",
"properties": {
"fb_downstream_use_xpost_metadata": {
"$ref": "#/components/schemas/FbDownstreamUseXpostMetadata"
}
},
"x-stoplight": {
"id": "lj27grpbtcyzh"
}
},
"InstagramHighlightReelsHighlightItemsItemGenAiDetectionMethod": {
"type": "object",
"properties": {
"detection_method": {
"title": "Detection method",
"type": "string"
}
},
"x-stoplight": {
"id": "yc7dotp0o2yx0"
}
},
"InstagramStoryPollTally": {
"type": "object",
"properties": {
"count": {
"title": "Count",
"type": "integer"
},
"font_size": {
"title": "Font size",
"type": "integer"
},
"text": {
"title": "Text",
"type": "string"
}
},
"x-stoplight": {
"id": "ezwprwao8s5f3"
}
},
"InstagramStoryPollSticker": {
"type": "object",
"properties": {
"color": {
"title": "Color",
"type": "string"
},
"finished": {
"title": "Finished",
"type": "boolean"
},
"id": {
"title": "Id",
"type": "string"
},
"is_multi_option_poll": {
"title": "Is multi option poll",
"type": "boolean"
},
"is_shared_result": {
"title": "Is shared result",
"type": "boolean"
},
"poll_id": {
"title": "Poll id",
"type": "integer"
},
"poll_type": {
"title": "Poll type",
"type": "string"
},
"question": {
"title": "Question",
"type": "string"
},
"total_votes": {
"title": "Total votes",
"type": "integer"
},
"viewer_can_vote": {
"title": "Viewer can vote",
"type": "boolean"
},
"promotion_tallies": {
"title": "Promotion tallies",
"type": "object",
"nullable": true
},
"social_context": {
"title": "Social context",
"type": "object",
"nullable": true
},
"tallies": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InstagramStoryPollTally"
}
}
},
"x-stoplight": {
"id": "7g0o4n5kfrx55"
}
},
"InstagramStoryPoll": {
"type": "object",
"properties": {
"end_time_ms": {
"title": "End time ms",
"type": "integer"
},
"height": {
"title": "Height",
"type": "number"
},
"is_fb_sticker": {
"title": "Is fb sticker",
"type": "integer"
},
"is_hidden": {
"title": "Is hidden",
"type": "integer"
},
"is_pinned": {
"title": "Is pinned",
"type": "integer"
},
"is_sticker": {
"title": "Is sticker",
"type": "integer"
},
"rotation": {
"title": "Rotation",
"type": "number"
},
"start_time_ms": {
"title": "Start time ms",
"type": "integer"
},
"width": {
"title": "Width",
"type": "number"
},
"x": {
"title": "X",
"type": "number"
},
"y": {
"title": "Y",
"type": "number"
},
"z": {
"title": "Z",
"type": "integer"
},
"poll_sticker": {
"$ref": "#/components/schemas/InstagramStoryPollSticker"
},
"media_code": {
"title": "Media code",
"type": "string"
},
"media_compound_str": {
"title": "Media compound str",
"type": "string"
},
"media_id": {
"title": "Media id",
"type": "string"
},
"media_type": {
"title": "Media type",
"type": "string"
},
"product_type": {
"title": "Product type",
"type": "string"
},
"should_mute_audio": {
"title": "Should mute audio",
"type": "boolean"
},
"uncapped_height_ratio": {
"title": "Uncapped height ratio",
"type": "number"
},
"uncapped_width_ratio": {
"title": "Uncapped width ratio",
"type": "number"
}
},
"x-stoplight": {
"id": "kieoldx9m1z35"
}
},
"InstagramHighlightReelsHighlightItemsItem": {
"required": [
"display_url"
],
"type": "object",
"properties": {
"pk": {
"title": "Pk",
"type": "string"
},
"id": {
"title": "Id",
"type": "string"
},
"like_and_view_counts_disabled": {
"title": "Like and view counts disabled",
"type": "boolean"
},
"is_post_live_clips_media": {
"title": "Is post live clips media",
"type": "boolean"
},
"is_reel_media": {
"title": "Is reel media",
"type": "boolean"
},
"fbid": {
"title": "Fbid",
"type": "string"
},
"caption_is_edited": {
"title": "Caption is edited",
"type": "boolean"
},
"strong_id__": {
"title": "Strong id ",
"type": "string"
},
"is_quicksnap_recap": {
"title": "Is quicksnap recap",
"type": "boolean"
},
"deleted_reason": {
"title": "Deleted reason",
"type": "integer"
},
"has_privately_liked": {
"title": "Has privately liked",
"type": "boolean"
},
"filter_type": {
"title": "Filter type",
"type": "integer"
},
"taken_at": {
"title": "Taken at",
"type": "integer"
},
"has_liked": {
"title": "Has liked",
"type": "boolean"
},
"is_dash_eligible": {
"title": "Is dash eligible",
"type": "integer"
},
"video_dash_manifest": {
"title": "Video dash manifest",
"type": "string"
},
"number_of_qualities": {
"title": "Number of qualities",
"type": "integer"
},
"video_versions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InstagramHighlightReelsHighlightItemsItemVideoVersionsItem"
}
},
"video_duration": {
"title": "Video duration",
"type": "number"
},
"has_audio": {
"title": "Has audio",
"type": "boolean"
},
"can_viewer_save": {
"title": "Can viewer save",
"type": "boolean"
},
"media_type": {
"title": "Media type",
"type": "integer"
},
"code": {
"title": "Code",
"type": "string"
},
"caption": {
"$ref": "#/components/schemas/InstagramUserInfoPostCaption"
},
"fundraiser_tag": {
"$ref": "#/components/schemas/InstagramHighlightReelsHighlightItemsItemFundraiserTag"
},
"timeline_pinned_user_ids": {
"type": "array",
"items": {
"type": "string",
"nullable": true
}
},
"has_translation": {
"title": "Has translation",
"type": "boolean"
},
"original_media_has_visual_reply_media": {
"title": "Original media has visual reply media",
"type": "boolean"
},
"coauthor_producers": {
"type": "array",
"items": {
"type": "string",
"nullable": true
}
},
"coauthor_producer_can_see_organic_insights": {
"title": "Coauthor producer can see organic insights",
"type": "boolean"
},
"invited_coauthor_producers": {
"type": "array",
"items": {
"type": "string",
"nullable": true
}
},
"highlights_info": {
"$ref": "#/components/schemas/InstagramHighlightReelsHighlightItemsItemHighlightsInfo"
},
"user": {
"$ref": "#/components/schemas/InstagramHighlightReelsHighlightItemsItemUser"
},
"display_url": {
"title": "Display url",
"type": "string"
},
"image_versions2": {
"$ref": "#/components/schemas/InstagramUserInfoPostImageVersion"
},
"original_width": {
"title": "Original width",
"type": "integer"
},
"original_height": {
"title": "Original height",
"type": "integer"
},
"product_type": {
"title": "Product type",
"type": "string"
},
"is_paid_partnership": {
"title": "Is paid partnership",
"type": "boolean"
},
"music_metadata": {
"$ref": "#/components/schemas/InstagramPostMusicMetadata"
},
"crosspost_metadata": {
"$ref": "#/components/schemas/InstagramHighlightReelsHighlightItemsItemCrosspostMetadata"
},
"gen_ai_detection_method": {
"$ref": "#/components/schemas/InstagramHighlightReelsHighlightItemsItemGenAiDetectionMethod"
},
"fb_aggregated_like_count": {
"title": "Fb aggregated like count",
"type": "integer"
},
"fb_aggregated_comment_count": {
"title": "Fb aggregated comment count",
"type": "integer"
},
"has_high_risk_gen_ai_inform_treatment": {
"title": "Has high risk gen ai inform treatment",
"type": "boolean"
},
"is_open_to_public_submission": {
"title": "Is open to public submission",
"type": "boolean"
},
"is_first_take": {
"title": "Is first take",
"type": "boolean"
},
"is_from_discovery_surface": {
"title": "Is from discovery surface",
"type": "boolean"
},
"supports_reel_reactions": {
"title": "Supports reel reactions",
"type": "boolean"
},
"is_photo_mash_story": {
"title": "Is photo mash story",
"type": "boolean"
},
"can_play_spotify_audio": {
"title": "Can play spotify audio",
"type": "boolean"
},
"is_superlative": {
"title": "Is superlative",
"type": "boolean"
},
"story_feed_media": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InstagramStoryPoll"
}
},
"is_viewer_mentioned": {
"title": "Is viewer mentioned",
"type": "boolean"
}
},
"x-stoplight": {
"id": "kwon6ib2j7lg7"
}
},
"InstagramHighlightReelsHighlight": {
"type": "object",
"properties": {
"id": {
"title": "Id",
"type": "string"
},
"strong_id__": {
"title": "Strong id ",
"type": "string"
},
"reel_type": {
"title": "Reel type",
"type": "string"
},
"cover_media": {
"$ref": "#/components/schemas/InstagramHighlightReelsHighlightCoverMedia"
},
"user": {
"$ref": "#/components/schemas/IGArtist"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InstagramHighlightReelsHighlightItemsItem"
}
},
"title": {
"title": "Title",
"type": "string"
},
"created_at": {
"title": "Created at",
"type": "integer"
},
"is_pinned_highlight": {
"title": "Is pinned highlight",
"type": "boolean"
},
"ranked_position": {
"title": "Ranked position",
"type": "integer"
},
"media_count": {
"title": "Media count",
"type": "integer"
},
"media_ids": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"highlight_reel_type": {
"title": "Highlight reel type",
"type": "string"
},
"updated_timestamp": {
"title": "Updated timestamp",
"type": "integer"
},
"is_archived": {
"title": "Is archived",
"type": "boolean"
},
"can_react_with_avatar": {
"title": "Can react with avatar",
"type": "boolean"
},
"prefetch_count": {
"title": "Prefetch count",
"type": "integer"
},
"is_converted_to_clips": {
"title": "Is converted to clips",
"type": "boolean"
},
"disabled_reply_types": {
"type": "array",
"items": {
"type": "string"
}
},
"is_added_to_main_grid": {
"title": "Is added to main grid",
"type": "boolean"
}
},
"x-stoplight": {
"id": "zq71iuibcbi63"
}
},
"InstagramHighlightReels": {
"type": "object",
"properties": {
"highlight": {
"$ref": "#/components/schemas/InstagramHighlightReelsHighlight"
}
},
"x-stoplight": {
"id": "gkva5npzlik0c"
}
},
"InstagramHighlightInfo": {
"required": [
"reels",
"status"
],
"type": "object",
"properties": {
"reels": {
"$ref": "#/components/schemas/InstagramHighlightReels"
},
"status": {
"title": "Status",
"type": "string",
"enum": [
"ok",
"not_found"
]
}
},
"x-stoplight": {
"id": "peecfec7066ke"
}
},
"InstagramComment": {
"required": [
"pk",
"created_at",
"text",
"user"
],
"type": "object",
"properties": {
"pk": {
"title": "Pk",
"type": "integer"
},
"created_at": {
"title": "Created at",
"type": "integer"
},
"text": {
"title": "Text",
"type": "string"
},
"user": {
"$ref": "#/components/schemas/InstagramUserPreviewInfo"
},
"comment_like_count": {
"title": "Comment like count",
"type": "integer"
},
"child_comment_count": {
"title": "Child comment count",
"type": "integer"
}
},
"x-stoplight": {
"id": "hwa353o2qywxw"
}
},
"InstagramPostComments": {
"required": [
"status"
],
"type": "object",
"properties": {
"status": {
"title": "Status",
"type": "string",
"enum": [
"ok",
"fail"
]
},
"comments_disabled": {
"title": "Comments disabled",
"type": "boolean"
},
"comments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InstagramComment"
}
},
"comment_count": {
"title": "Comment count",
"type": "integer"
},
"has_more_comments": {
"title": "Has more comments",
"type": "boolean",
"readOnly": true,
"nullable": true
},
"end_cursor": {
"title": "End cursor",
"type": "string",
"readOnly": true,
"nullable": true
}
},
"x-stoplight": {
"id": "d2c4xhqt9w2pm"
}
},
"InstagramPostCommentReplies": {
"required": [
"status"
],
"type": "object",
"properties": {
"status": {
"title": "Status",
"type": "string",
"enum": [
"ok",
"fail"
]
},
"child_comments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InstagramComment"
}
},
"end_cursor": {
"title": "End cursor",
"type": "string",
"readOnly": true,
"nullable": true
}
},
"x-stoplight": {
"id": "tqq1cmksas8vt"
}
},
"InstagramPostInfo": {
"required": [
"status"
],
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InstagramPostData"
}
},
"status": {
"title": "Status",
"type": "string",
"enum": [
"ok",
"fail"
]
}
},
"x-stoplight": {
"id": "ejtd10zj24h6n"
}
},
"InstagramPostDataMore": {
"required": [
"pk",
"display_url",
"taken_at",
"code",
"media_type",
"user"
],
"type": "object",
"properties": {
"pk": {
"title": "Pk",
"type": "integer"
},
"display_url": {
"title": "Display url",
"type": "string"
},
"image_versions2": {
"$ref": "#/components/schemas/InstagramUserInfoPostImageVersion"
},
"has_audio": {
"title": "Has audio",
"type": "boolean"
},
"is_dash_eligible": {
"title": "Is dash eligible",
"type": "string",
"minLength": 1
},
"video_dash_manifest": {
"title": "Video dash manifest",
"type": "string",
"minLength": 1,
"nullable": true
},
"number_of_qualities": {
"title": "Number of qualities",
"type": "integer"
},
"video_url": {
"title": "Video url",
"type": "string",
"readOnly": true,
"nullable": true
},
"video_subtitles_uri": {
"title": "Video subtitles uri",
"type": "string",
"nullable": true
},
"video_subtitles_locale": {
"title": "Video subtitles locale",
"type": "string",
"nullable": true
},
"usertags": {
"$ref": "#/components/schemas/InstagramUserInfoPostUserTags"
},
"taken_at": {
"title": "Taken at",
"type": "integer"
},
"code": {
"title": "Code",
"type": "string",
"minLength": 1
},
"comment_count": {
"title": "Comment count",
"type": "integer"
},
"like_count": {
"title": "Like count",
"type": "integer"
},
"fb_like_count": {
"title": "Fb like count",
"type": "integer"
},
"view_count": {
"title": "View count",
"type": "integer"
},
"play_count": {
"title": "Play count",
"type": "integer",
"nullable": true
},
"ig_play_count": {
"title": "Ig play count",
"type": "integer"
},
"fb_play_count": {
"title": "Fb play count",
"type": "integer"
},
"fb_comment_count": {
"title": "Fb comment count",
"type": "integer"
},
"like_and_view_counts_disabled": {
"title": "Like and view counts disabled",
"type": "boolean"
},
"media_type": {
"title": "Media type",
"description": "```0``` - clips, ```1``` - photo, ```2``` - video, ```8``` - carousel, ```13``` - guide",
"type": "integer",
"enum": [
0,
1,
2,
8,
13
]
},
"video_duration": {
"title": "Video duration",
"type": "number"
},
"caption": {
"$ref": "#/components/schemas/InstagramUserInfoPostCaption"
},
"title": {
"title": "Title",
"type": "string",
"nullable": true
},
"user": {
"$ref": "#/components/schemas/InstagramUserPreviewInfo"
},
"coauthor_producers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InstagramCoauthorUserInfo"
},
"nullable": true
},
"location": {
"$ref": "#/components/schemas/InstagramUserInfoPostLocation"
},
"product_type": {
"title": "Product type",
"description": "Known values: ```\"feed\"```, ```\"carousel_container\"```, ```\"carousel_item\"```, ```\"igtv\"```, ```\"clips\"```, ```\"ad\"```, ```\"story\"```, ```\"guide_media_facade\"```",
"type": "string"
},
"timeline_pinned_user_ids": {
"type": "array",
"items": {
"type": "integer"
}
},
"can_viewer_reshare": {
"title": "Can viewer reshare",
"type": "boolean"
},
"reshare_count": {
"title": "Reshare count",
"type": "integer"
},
"is_paid_partnership": {
"title": "Is paid partnership",
"type": "boolean"
},
"sponsor_tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InstagramPostSponsorItem"
},
"nullable": true
},
"carousel_media_count": {
"title": "Carousel media count",
"type": "integer"
},
"carousel_media": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InstagramPostCarouselMedia"
}
},
"clips_metadata": {
"$ref": "#/components/schemas/InstagramPostClipsMetadata"
},
"music_metadata": {
"$ref": "#/components/schemas/InstagramPostMusicMetadata"
},
"media_repost_count": {
"title": "Media repost count",
"type": "integer"
}
},
"x-stoplight": {
"id": "vxbw1a7bvfvgd"
}
},
"InstagramPostInfoMore": {
"required": [
"status"
],
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InstagramPostDataMore"
}
},
"status": {
"title": "Status",
"type": "string",
"enum": [
"ok",
"fail"
]
}
},
"x-stoplight": {
"id": "1h3xazmt94j7c"
}
},
"InstagramReelData": {
"required": [
"media"
],
"type": "object",
"properties": {
"media": {
"$ref": "#/components/schemas/InstagramPostData"
}
},
"x-stoplight": {
"id": "t2llu2fgs3fh6"
}
},
"InstagramSearchReelsSerpModules": {
"type": "object",
"properties": {
"module_type": {
"title": "Module type",
"type": "string",
"minLength": 1
},
"clips": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InstagramReelData"
}
}
},
"x-stoplight": {
"id": "ye6oijdy5scwn"
}
},
"InstagramSearchReels": {
"required": [
"status"
],
"type": "object",
"properties": {
"reels_serp_modules": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InstagramSearchReelsSerpModules"
}
},
"more_available": {
"title": "More available",
"type": "boolean",
"readOnly": true
},
"end_cursor": {
"title": "End cursor",
"type": "string",
"readOnly": true,
"nullable": true
},
"status": {
"title": "Status",
"type": "string",
"enum": [
"ok",
"fail"
]
}
},
"x-stoplight": {
"id": "05nsrvzbevw97"
}
},
"InstagramSerpUser": {
"required": [
"pk",
"username",
"full_name"
],
"type": "object",
"properties": {
"pk": {
"title": "Pk",
"type": "integer"
},
"id": {
"title": "Id",
"type": "string",
"nullable": true
},
"username": {
"title": "Username",
"type": "string",
"minLength": 1
},
"full_name": {
"title": "Full name",
"type": "string"
},
"strong_id__": {
"title": "Strong id ",
"type": "string",
"nullable": true
},
"profile_pic_url": {
"title": "Profile pic url",
"type": "string",
"minLength": 1
},
"is_private": {
"title": "Is private",
"type": "boolean",
"nullable": true
},
"is_verified": {
"title": "Is verified",
"type": "boolean",
"nullable": true
},
"social_context": {
"title": "Social context",
"description": "Text like '301M followers'",
"type": "string",
"nullable": true
}
},
"x-stoplight": {
"id": "iuuzrqvi1zlih"
}
},
"InstagramSerp": {
"required": [
"num_results"
],
"type": "object",
"properties": {
"num_results": {
"title": "Num results",
"type": "integer"
},
"users": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InstagramSerpUser"
}
},
"has_more": {
"title": "Has more",
"type": "boolean"
}
},
"x-stoplight": {
"id": "6e2sf24djw76l"
}
},
"InstagramPostFeed": {
"required": [
"status"
],
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InstagramPostData"
}
},
"more_available": {
"title": "More available",
"type": "boolean"
},
"end_cursor": {
"title": "End cursor",
"type": "string",
"readOnly": true,
"nullable": true
},
"status": {
"title": "Status",
"type": "string",
"enum": [
"ok",
"fail"
]
}
},
"x-stoplight": {
"id": "liyd3zwlo86zj"
}
},
"InstagramPostFeedMore": {
"required": [
"status"
],
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InstagramPostDataMore"
}
},
"more_available": {
"title": "More available",
"type": "boolean"
},
"end_cursor": {
"title": "End cursor",
"type": "string",
"readOnly": true,
"nullable": true
},
"status": {
"title": "Status",
"type": "string",
"enum": [
"ok",
"fail"
]
}
},
"x-stoplight": {
"id": "aoc7910yhzhj1"
}
},
"InstagramUserHighlights": {
"required": [
"tray",
"status"
],
"type": "object",
"properties": {
"tray": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InstagramHighlightReelsHighlight"
}
},
"status": {
"title": "Status",
"type": "string",
"enum": [
"ok",
"fail"
]
}
},
"x-stoplight": {
"id": "adi9oopy79668"
}
},
"InstagramIgtvFeed": {
"required": [
"status"
],
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InstagramPostData"
}
},
"more_available": {
"title": "More available",
"type": "boolean"
},
"end_cursor": {
"title": "End cursor",
"type": "string",
"readOnly": true,
"nullable": true
},
"status": {
"title": "Status",
"type": "string",
"enum": [
"ok",
"fail"
]
}
},
"x-stoplight": {
"id": "b0l2n2qr6no2h"
}
},
"Gating": {
"type": "object",
"properties": {
"gating_type": {
"title": "Gating type",
"type": "string",
"nullable": true
},
"title": {
"title": "Title",
"type": "string",
"nullable": true
},
"description": {
"title": "Description",
"type": "string",
"nullable": true
},
"buttons": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"default": []
},
"show_notice": {
"title": "Show notice",
"type": "boolean",
"nullable": true
},
"geo_block_rule_type": {
"title": "Geo block rule type",
"type": "object",
"nullable": true
}
},
"nullable": true,
"x-stoplight": {
"id": "9ct82sbthvqrs"
}
},
"BioLink": {
"type": "object",
"properties": {
"link_id": {
"title": "Link id",
"type": "integer",
"nullable": true
},
"url": {
"title": "Url",
"type": "string",
"nullable": true
},
"link_type": {
"title": "Link type",
"type": "string",
"nullable": true
},
"title": {
"title": "Title",
"type": "string",
"nullable": true
},
"media_type": {
"title": "Media type",
"type": "string",
"nullable": true
},
"image_url": {
"title": "Image url",
"type": "string",
"nullable": true
},
"icon_url": {
"title": "Icon url",
"type": "string",
"nullable": true
},
"is_pinned": {
"title": "Is pinned",
"type": "boolean",
"nullable": true
},
"is_verified": {
"title": "Is verified",
"type": "boolean",
"nullable": true
},
"open_external_url_with_in_app_browser": {
"title": "Open external url with in app browser",
"type": "boolean",
"nullable": true
}
},
"default": {
"link_id": null,
"url": null,
"link_type": null,
"title": null,
"media_type": null,
"image_url": null,
"icon_url": null,
"is_pinned": null,
"is_verified": null,
"open_external_url_with_in_app_browser": null
},
"x-stoplight": {
"id": "ylc3vkn7a3xzr"
}
},
"InstagramUserInfoData": {
"required": [
"pk",
"username",
"full_name",
"is_business",
"is_private",
"is_verified",
"media_count",
"follower_count",
"following_count"
],
"type": "object",
"properties": {
"pk": {
"title": "Pk",
"type": "integer"
},
"username": {
"title": "Username",
"type": "string",
"minLength": 1
},
"full_name": {
"title": "Full name",
"type": "string"
},
"profile_pic_url": {
"title": "Profile pic url",
"type": "string",
"minLength": 1
},
"profile_pic_url_hd": {
"title": "Profile pic url hd",
"type": "string",
"readOnly": true
},
"is_business": {
"title": "Is business",
"type": "boolean"
},
"is_private": {
"title": "Is private",
"type": "boolean"
},
"is_verified": {
"title": "Is verified",
"type": "boolean"
},
"media_count": {
"title": "Media count",
"type": "integer"
},
"follower_count": {
"title": "Follower count",
"type": "integer"
},
"following_count": {
"title": "Following count",
"type": "integer"
},
"gating": {
"$ref": "#/components/schemas/Gating"
},
"is_regulated_c18": {
"title": "Is regulated c18",
"description": "whether a news organization’s account is blocked from view in Canada",
"type": "boolean",
"nullable": true
},
"fbid": {
"title": "Fbid",
"type": "string",
"nullable": true
},
"biography": {
"title": "Biography",
"type": "string"
},
"external_url": {
"title": "External url",
"type": "string"
},
"has_highlight_reels": {
"title": "Has highlight reels",
"type": "boolean",
"default": false
},
"category": {
"title": "Category",
"type": "string",
"nullable": true
},
"has_clips": {
"title": "Has clips",
"type": "string",
"readOnly": true
},
"has_guides": {
"title": "Has guides",
"type": "boolean"
},
"has_channel": {
"title": "Has channel",
"type": "string",
"readOnly": true
},
"total_igtv_videos": {
"title": "Total igtv videos",
"type": "integer"
},
"bio_links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BioLink"
},
"default": []
},
"fbid_v2": {
"title": "Fbid v2",
"type": "integer"
}
},
"x-stoplight": {
"id": "u9j2hz6z5ep8j"
}
},
"InstagramUserInfo": {
"required": [
"status"
],
"type": "object",
"properties": {
"status": {
"title": "Status",
"type": "string",
"enum": [
"ok",
"not_found"
]
},
"user": {
"$ref": "#/components/schemas/InstagramUserInfoData"
}
},
"x-stoplight": {
"id": "x3h6fxpgjkb96"
}
},
"InstagramReelsFeed": {
"required": [
"status"
],
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InstagramReelData"
}
},
"more_available": {
"title": "More available",
"type": "string",
"readOnly": true,
"nullable": true
},
"end_cursor": {
"title": "End cursor",
"type": "string",
"readOnly": true,
"nullable": true
},
"status": {
"title": "Status",
"type": "string",
"enum": [
"ok",
"fail"
]
}
},
"x-stoplight": {
"id": "zsbppui5kqtyt"
}
},
"InstagramReelDataMore": {
"required": [
"media"
],
"type": "object",
"properties": {
"media": {
"$ref": "#/components/schemas/InstagramPostDataMore"
}
},
"x-stoplight": {
"id": "2132wt3cgv8h6"
}
},
"InstagramReelsFeedMore": {
"required": [
"status"
],
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InstagramReelDataMore"
}
},
"more_available": {
"title": "More available",
"type": "string",
"readOnly": true,
"nullable": true
},
"end_cursor": {
"title": "End cursor",
"type": "string",
"readOnly": true,
"nullable": true
},
"status": {
"title": "Status",
"type": "string",
"enum": [
"ok",
"fail"
]
}
},
"x-stoplight": {
"id": "7gnz39uiyzamy"
}
},
"InstagramUserReelUserInfo": {
"required": [
"pk",
"username",
"full_name",
"is_private",
"is_verified"
],
"type": "object",
"properties": {
"pk": {
"title": "Pk",
"type": "integer"
},
"username": {
"title": "Username",
"type": "string",
"minLength": 1
},
"full_name": {
"title": "Full name",
"type": "string"
},
"profile_pic_url": {
"title": "Profile pic url",
"type": "string",
"minLength": 1
},
"is_private": {
"title": "Is private",
"type": "boolean"
},
"is_verified": {
"title": "Is verified",
"type": "boolean"
}
},
"x-stoplight": {
"id": "z9sg4ww6aa864"
}
},
"InstagramUserReelUserInfoInItem": {
"required": [
"pk",
"is_private"
],
"type": "object",
"properties": {
"pk": {
"title": "Pk",
"type": "integer"
},
"username": {
"title": "Username",
"type": "string",
"minLength": 1
},
"full_name": {
"title": "Full name",
"type": "string"
},
"profile_pic_url": {
"title": "Profile pic url",
"type": "string",
"minLength": 1
},
"is_private": {
"title": "Is private",
"type": "boolean"
},
"is_verified": {
"title": "Is verified",
"type": "boolean"
}
},
"x-stoplight": {
"id": "iwlepbbgzty2q"
}
},
"InstagramUserReelMention": {
"required": [
"x",
"y",
"width",
"height",
"rotation",
"is_pinned",
"is_sticker"
],
"type": "object",
"properties": {
"x": {
"title": "X",
"type": "number",
"nullable": true
},
"y": {
"title": "Y",
"type": "number",
"nullable": true
},
"width": {
"title": "Width",
"type": "number"
},
"height": {
"title": "Height",
"type": "number"
},
"rotation": {
"title": "Rotation",
"type": "number"
},
"is_pinned": {
"title": "Is pinned",
"type": "integer"
},
"is_sticker": {
"title": "Is sticker",
"type": "integer"
},
"display_type": {
"title": "Display type",
"type": "string",
"enum": [
"mention_username",
"mention_reshare",
"mention_professional_username",
"mention_profile_sticker",
"mention_immersive_public_story_reshare",
"mention_public_story_reshare",
"group_mention",
"mention_valentines",
"mention_anti_valentines",
"pics_please_response_share",
"music_hidden"
]
},
"user": {
"$ref": "#/components/schemas/InstagramUserPreviewInfo"
}
},
"x-stoplight": {
"id": "h0d6qgoz5wymt"
}
},
"InstagramUserReelGroupMentionSticker": {
"required": [
"mentioned_users"
],
"type": "object",
"properties": {
"text": {
"title": "Text",
"type": "string",
"nullable": true
},
"mentioned_users": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InstagramUserPreviewInfo"
}
}
},
"x-stoplight": {
"id": "50rszee89v0ql"
}
},
"InstagramUserReelGroupMention": {
"required": [
"x",
"y",
"width",
"height",
"rotation",
"is_pinned",
"is_sticker",
"group_mention_sticker"
],
"type": "object",
"properties": {
"x": {
"title": "X",
"type": "number"
},
"y": {
"title": "Y",
"type": "number"
},
"width": {
"title": "Width",
"type": "number"
},
"height": {
"title": "Height",
"type": "number"
},
"rotation": {
"title": "Rotation",
"type": "number"
},
"is_pinned": {
"title": "Is pinned",
"type": "integer"
},
"is_sticker": {
"title": "Is sticker",
"type": "integer"
},
"group_mention_sticker": {
"$ref": "#/components/schemas/InstagramUserReelGroupMentionSticker"
}
},
"x-stoplight": {
"id": "s4rg34g9jpv49"
}
},
"InstagramUserStoryCtaLinks": {
"type": "object",
"properties": {
"linkType": {
"title": "Linktype",
"type": "integer",
"enum": [
1,
3
]
},
"webUri": {
"title": "Weburi",
"type": "string"
},
"androidClass": {
"title": "Androidclass",
"type": "string"
},
"package": {
"title": "Package",
"type": "string"
},
"deeplinkUri": {
"title": "Deeplinkuri",
"type": "string"
},
"callToActionTitle": {
"title": "Calltoactiontitle",
"type": "string"
},
"redirectUri": {
"title": "Redirecturi",
"type": "string",
"nullable": true
},
"igUserId": {
"title": "Iguserid",
"type": "string",
"nullable": true
}
},
"x-stoplight": {
"id": "fdwwx27181pgm"
}
},
"InstagramUserStoryCta": {
"type": "object",
"properties": {
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InstagramUserStoryCtaLinks"
}
}
},
"x-stoplight": {
"id": "7prshvh3qs4hi"
}
},
"InstagramUserStoryHashtagInfo": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"title": "Name",
"type": "string",
"minLength": 1
},
"id": {
"title": "Id",
"type": "integer"
}
},
"x-stoplight": {
"id": "u8ce33gxdh9s9"
}
},
"InstagramUserStoryHashtag": {
"required": [
"x",
"y",
"width",
"height",
"rotation",
"is_pinned",
"is_sticker",
"hashtag"
],
"type": "object",
"properties": {
"x": {
"title": "X",
"type": "number"
},
"y": {
"title": "Y",
"type": "number"
},
"width": {
"title": "Width",
"type": "number"
},
"height": {
"title": "Height",
"type": "number"
},
"rotation": {
"title": "Rotation",
"type": "number"
},
"is_pinned": {
"title": "Is pinned",
"type": "integer"
},
"is_sticker": {
"title": "Is sticker",
"type": "integer"
},
"hashtag": {
"$ref": "#/components/schemas/InstagramUserStoryHashtagInfo"
}
},
"x-stoplight": {
"id": "gr1sa6eeoemqe"
}
},
"InstagramUserStoryFeedMedia": {
"required": [
"x",
"y",
"width",
"height",
"rotation",
"is_pinned",
"is_sticker"
],
"type": "object",
"properties": {
"x": {
"title": "X",
"type": "number"
},
"y": {
"title": "Y",
"type": "number"
},
"width": {
"title": "Width",
"type": "number"
},
"height": {
"title": "Height",
"type": "number"
},
"rotation": {
"title": "Rotation",
"type": "number"
},
"is_pinned": {
"title": "Is pinned",
"type": "integer"
},
"is_sticker": {
"title": "Is sticker",
"type": "integer"
},
"media_id": {
"title": "Media id",
"type": "string",
"minLength": 1
},
"product_type": {
"title": "Product type",
"description": "Known values: ```\"feed\"```, ```\"igtv\"```, ```\"clips\"```, ```\"story\"```, ```\"multipost\"```, ```\"ad\"```",
"type": "string"
},
"media_code": {
"title": "Media code",
"type": "string",
"minLength": 1
},
"media_compound_str": {
"title": "Media compound str",
"type": "string",
"minLength": 1
}
},
"x-stoplight": {
"id": "4p4lxarkd66s8"
}
},
"InstagramUserStoryLinkStickerStoryLink": {
"required": [
"link_type",
"url",
"display_url"
],
"type": "object",
"properties": {
"link_type": {
"title": "Link type",
"type": "string",
"enum": [
"web"
]
},
"url": {
"title": "Url",
"type": "string"
},
"link_title": {
"title": "Link title",
"type": "string"
},
"display_url": {
"title": "Display url",
"type": "string"
}
},
"x-stoplight": {
"id": "uadw14nc8pb5j"
}
},
"InstagramUserStoryLinkSticker": {
"required": [
"x",
"y",
"width",
"height",
"rotation",
"is_pinned",
"is_sticker",
"story_link"
],
"type": "object",
"properties": {
"x": {
"title": "X",
"type": "number"
},
"y": {
"title": "Y",
"type": "number"
},
"width": {
"title": "Width",
"type": "number"
},
"height": {
"title": "Height",
"type": "number"
},
"rotation": {
"title": "Rotation",
"type": "number"
},
"is_pinned": {
"title": "Is pinned",
"type": "integer"
},
"is_sticker": {
"title": "Is sticker",
"type": "integer"
},
"story_link": {
"$ref": "#/components/schemas/InstagramUserStoryLinkStickerStoryLink"
}
},
"x-stoplight": {
"id": "uuv833mix0iqj"
}
},
"InstagramOriginalSoundInfo": {
"type": "object",
"properties": {
"allow_creator_to_rename": {
"title": "Allow creator to rename",
"type": "boolean"
},
"audio_asset_id": {
"title": "Audio asset id",
"type": "integer"
},
"attributed_custom_audio_asset_id": {
"title": "Attributed custom audio asset id",
"type": "string",
"nullable": true
},
"can_remix_be_shared_to_fb": {
"title": "Can remix be shared to fb",
"type": "boolean",
"nullable": true
},
"can_remix_be_shared_to_fb_expansion": {
"title": "Can remix be shared to fb expansion",
"type": "boolean",
"nullable": true
},
"dash_manifest": {
"title": "Dash manifest",
"type": "string"
},
"duration_in_ms": {
"title": "Duration in ms",
"type": "integer",
"nullable": true
},
"hide_remixing": {
"title": "Hide remixing",
"type": "boolean"
},
"is_audio_automatically_attributed": {
"title": "Is audio automatically attributed",
"type": "boolean"
},
"is_eligible_for_audio_effects": {
"title": "Is eligible for audio effects",
"type": "boolean",
"nullable": true
},
"is_eligible_for_vinyl_sticker": {
"title": "Is eligible for vinyl sticker",
"type": "boolean",
"nullable": true
},
"is_explicit": {
"title": "Is explicit",
"type": "boolean",
"nullable": true
},
"is_original_audio_download_eligible": {
"title": "Is original audio download eligible",
"type": "boolean"
},
"is_reuse_disabled": {
"title": "Is reuse disabled",
"type": "boolean"
},
"oa_owner_is_music_artist": {
"title": "Oa owner is music artist",
"type": "boolean"
},
"original_audio_subtype": {
"title": "Original audio subtype",
"type": "string"
},
"original_audio_title": {
"title": "Original audio title",
"type": "string"
},
"original_media_id": {
"title": "Original media id",
"type": "integer"
},
"progressive_download_url": {
"title": "Progressive download url",
"type": "string",
"nullable": true
},
"should_mute_audio": {
"title": "Should mute audio",
"type": "boolean",
"nullable": true
},
"time_created": {
"title": "Time created",
"type": "integer"
},
"overlap_duration_in_ms": {
"title": "Overlap duration in ms",
"type": "integer",
"nullable": true
},
"audio_asset_start_time_in_ms": {
"title": "Audio asset start time in ms",
"type": "integer",
"nullable": true
},
"ig_artist": {
"$ref": "#/components/schemas/InstagramUserPreviewInfo"
},
"consumption_info": {
"$ref": "#/components/schemas/MusicConsumptionInfo"
},
"fb_downstream_use_xpost_metadata": {
"$ref": "#/components/schemas/FbDownstreamUseXpostMetadata"
}
},
"nullable": true,
"x-stoplight": {
"id": "tdhiffaerdhy7"
}
},
"InstagramUserStoryMusicSticker": {
"required": [
"x",
"y",
"width",
"height",
"rotation",
"is_pinned",
"is_sticker"
],
"type": "object",
"properties": {
"x": {
"title": "X",
"type": "number"
},
"y": {
"title": "Y",
"type": "number"
},
"width": {
"title": "Width",
"type": "number"
},
"height": {
"title": "Height",
"type": "number"
},
"rotation": {
"title": "Rotation",
"type": "number"
},
"is_pinned": {
"title": "Is pinned",
"type": "integer"
},
"is_sticker": {
"title": "Is sticker",
"type": "integer"
},
"attribution": {
"title": "Attribution",
"type": "string",
"minLength": 1
},
"display_type": {
"title": "Display type",
"type": "string",
"minLength": 1
},
"music_asset_info": {
"$ref": "#/components/schemas/InstagramMusicInfoMusicAssetInfo"
},
"original_sound_info": {
"$ref": "#/components/schemas/InstagramOriginalSoundInfo"
}
},
"x-stoplight": {
"id": "gqcmjg7pehl01"
}
},
"InstagramUserStoryLocation": {
"required": [
"x",
"y",
"width",
"height",
"is_pinned",
"is_sticker"
],
"type": "object",
"properties": {
"x": {
"title": "X",
"type": "number"
},
"y": {
"title": "Y",
"type": "number"
},
"width": {
"title": "Width",
"type": "number"
},
"height": {
"title": "Height",
"type": "number"
},
"is_pinned": {
"title": "Is pinned",
"type": "integer"
},
"is_sticker": {
"title": "Is sticker",
"type": "integer"
},
"location": {
"$ref": "#/components/schemas/InstagramUserInfoPostLocation"
}
},
"x-stoplight": {
"id": "iut8bkjkzl9xa"
}
},
"InstagramUserInfoPostVideoVersion": {
"required": [
"type",
"width",
"height",
"url",
"id"
],
"type": "object",
"properties": {
"type": {
"title": "Type",
"type": "integer"
},
"width": {
"title": "Width",
"type": "integer"
},
"height": {
"title": "Height",
"type": "integer"
},
"url": {
"title": "Url",
"type": "string",
"minLength": 1
},
"id": {
"title": "Id",
"type": "string",
"minLength": 1
}
},
"x-stoplight": {
"id": "skcgfoxec4479"
}
},
"InstagramStoryCommentUser": {
"type": "object",
"properties": {
"pk": {
"title": "Pk",
"type": "integer"
},
"pk_id": {
"title": "Pk id",
"type": "string",
"nullable": true
},
"id": {
"title": "Id",
"type": "string",
"nullable": true
},
"full_name": {
"title": "Full name",
"type": "string",
"nullable": true
},
"strong_id__": {
"title": "Strong id ",
"type": "string",
"nullable": true
},
"fbid_v2": {
"title": "Fbid v2",
"type": "integer",
"nullable": true
},
"username": {
"title": "Username",
"type": "string",
"nullable": true
},
"is_private": {
"title": "Is private",
"type": "boolean",
"nullable": true
},
"is_verified": {
"title": "Is verified",
"type": "boolean",
"nullable": true
},
"profile_pic_id": {
"title": "Profile pic id",
"type": "string",
"nullable": true
},
"profile_pic_url": {
"title": "Profile pic url",
"type": "string",
"nullable": true
}
},
"nullable": true,
"x-stoplight": {
"id": "vs3np4hpuezop"
}
},
"InstagramStoryComment": {
"type": "object",
"properties": {
"pk": {
"title": "Pk",
"type": "string",
"nullable": true
},
"user_id": {
"title": "User id",
"type": "integer",
"nullable": true
},
"type": {
"title": "Type",
"type": "integer",
"nullable": true
},
"did_report_as_spam": {
"title": "Did report as spam",
"type": "boolean",
"nullable": true
},
"created_at": {
"title": "Created at",
"type": "integer",
"nullable": true
},
"created_at_utc": {
"title": "Created at utc",
"type": "integer",
"nullable": true
},
"created_at_for_fb_app": {
"title": "Created at for fb app",
"type": "integer",
"nullable": true
},
"content_type": {
"title": "Content type",
"type": "string",
"nullable": true
},
"status": {
"title": "Status",
"type": "string",
"nullable": true
},
"bit_flags": {
"title": "Bit flags",
"type": "integer",
"nullable": true
},
"share_enabled": {
"title": "Share enabled",
"type": "boolean",
"nullable": true
},
"is_ranked_comment": {
"title": "Is ranked comment",
"type": "boolean",
"nullable": true
},
"media_id": {
"title": "Media id",
"type": "number",
"nullable": true
},
"strong_id__": {
"title": "Strong id ",
"type": "string",
"nullable": true
},
"text": {
"title": "Text",
"type": "string",
"nullable": true
},
"is_covered": {
"title": "Is covered",
"type": "boolean",
"nullable": true
},
"has_translation": {
"title": "Has translation",
"type": "boolean",
"nullable": true
},
"user": {
"$ref": "#/components/schemas/InstagramStoryCommentUser"
}
},
"x-stoplight": {
"id": "3ncorgevzdl2y"
}
},
"InstagramUserReelInfo": {
"required": [
"pk",
"taken_at",
"media_type",
"code",
"has_translation"
],
"type": "object",
"properties": {
"pk": {
"title": "Pk",
"type": "integer"
},
"id": {
"title": "Id",
"type": "string",
"minLength": 1
},
"taken_at": {
"title": "Taken at",
"type": "integer"
},
"expiring_at": {
"title": "Expiring at",
"type": "integer"
},
"media_type": {
"title": "Media type",
"description": "```0``` - clips, ```1``` - photo, ```2``` - video",
"type": "integer",
"enum": [
0,
1,
2
]
},
"code": {
"title": "Code",
"type": "string",
"minLength": 1
},
"has_translation": {
"title": "Has translation",
"description": "if instagram has auto translated audio and/or text on images",
"type": "boolean"
},
"attribution_content_url": {
"title": "Attribution content url",
"description": "Present when the story comes from a post or another story, contains a threads url that contains the short code of the original post/story. Complementary with feed stickers",
"type": "string",
"nullable": true
},
"user": {
"$ref": "#/components/schemas/InstagramUserReelUserInfoInItem"
},
"image_versions2": {
"$ref": "#/components/schemas/InstagramUserInfoPostImageVersion"
},
"reel_mentions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InstagramUserReelMention"
}
},
"group_mentions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InstagramUserReelGroupMention"
}
},
"ad_action": {
"title": "Ad action",
"type": "string",
"enum": [
"webclick"
]
},
"link_text": {
"title": "Link text",
"type": "string",
"minLength": 1
},
"story_cta": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InstagramUserStoryCta"
}
},
"story_hashtags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InstagramUserStoryHashtag"
}
},
"story_feed_media": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InstagramUserStoryFeedMedia"
}
},
"story_link_stickers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InstagramUserStoryLinkSticker"
}
},
"story_music_stickers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InstagramUserStoryMusicSticker"
}
},
"story_locations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InstagramUserStoryLocation"
}
},
"is_paid_partnership": {
"title": "Is paid partnership",
"type": "boolean"
},
"sponsor_tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InstagramPostSponsorItem"
},
"nullable": true
},
"is_dash_eligible": {
"title": "Is dash eligible",
"type": "integer",
"enum": [
1
]
},
"video_dash_manifest": {
"title": "Video dash manifest",
"type": "string",
"minLength": 1,
"nullable": true
},
"video_codec": {
"title": "Video codec",
"type": "string",
"minLength": 1
},
"number_of_qualities": {
"title": "Number of qualities",
"type": "integer"
},
"video_versions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InstagramUserInfoPostVideoVersion"
}
},
"has_audio": {
"title": "Has audio",
"type": "boolean"
},
"video_duration": {
"title": "Video duration",
"type": "number"
},
"story_polls": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InstagramStoryPoll"
}
},
"story_comments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InstagramStoryComment"
}
}
},
"x-stoplight": {
"id": "bq7mvwe2dzgic"
}
},
"InstagramUserReel": {
"required": [
"latest_reel_media",
"expiring_at",
"media_count"
],
"type": "object",
"properties": {
"latest_reel_media": {
"title": "Latest reel media",
"type": "integer"
},
"expiring_at": {
"title": "Expiring at",
"type": "integer"
},
"media_count": {
"title": "Media count",
"type": "integer"
},
"user": {
"$ref": "#/components/schemas/InstagramUserReelUserInfo"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InstagramUserReelInfo"
}
}
},
"nullable": true,
"x-stoplight": {
"id": "acs3flzz979ou"
}
},
"InstagramUserStories": {
"required": [
"status"
],
"type": "object",
"properties": {
"status": {
"title": "Status",
"type": "string",
"enum": [
"ok",
"not_found"
]
},
"reel": {
"$ref": "#/components/schemas/InstagramUserReel"
}
},
"x-stoplight": {
"id": "g2r4i2b36scmo"
}
},
"TiktokMediaVideoSubtitleInfo": {
"type": "object",
"properties": {
"LanguageID": {
"title": "Languageid",
"type": "integer"
},
"LanguageCodeName": {
"title": "Languagecodename",
"type": "string"
},
"Url": {
"title": "Url",
"type": "string"
},
"UrlExpire": {
"title": "Urlexpire",
"type": "integer"
},
"Format": {
"title": "Format",
"type": "string"
},
"Version": {
"title": "Version",
"type": "string"
},
"Source": {
"title": "Source",
"type": "string"
},
"Size": {
"title": "Size",
"type": "integer"
}
},
"x-stoplight": {
"id": "7j1pi4a6x4dsw"
}
},
"TiktokMediaVideoCaptionInfo": {
"type": "object",
"properties": {
"captionFormat": {
"title": "Captionformat",
"type": "string"
},
"claSubtitleID": {
"title": "Clasubtitleid",
"type": "string"
},
"expire": {
"title": "Expire",
"type": "string"
},
"isAutoGen": {
"title": "Isautogen",
"type": "boolean"
},
"isOriginalCaption": {
"title": "Isoriginalcaption",
"type": "boolean"
},
"language": {
"title": "Language",
"type": "string"
},
"languageCode": {
"title": "Languagecode",
"type": "string"
},
"languageID": {
"title": "Languageid",
"type": "string"
},
"subID": {
"title": "Subid",
"type": "string"
},
"subtitleType": {
"title": "Subtitletype",
"type": "string"
},
"translationType": {
"title": "Translationtype",
"type": "integer"
},
"url": {
"title": "Url",
"type": "string"
},
"urlList": {
"type": "array",
"items": {
"type": "string"
}
},
"variant": {
"title": "Variant",
"type": "string"
}
},
"x-stoplight": {
"id": "akx0t5tvylp9k"
}
},
"TiktokMediaVideoOriginalLanguageInfo": {
"type": "object",
"properties": {
"language": {
"title": "Language",
"type": "string"
},
"languageCode": {
"title": "Languagecode",
"type": "string"
},
"languageID": {
"title": "Languageid",
"type": "string"
}
},
"x-stoplight": {
"id": "srdm0cwebitjw"
}
},
"TiktokMediaVideoClaInfo": {
"type": "object",
"properties": {
"hasOriginalAudio": {
"title": "Hasoriginalaudio",
"type": "boolean"
},
"noCaptionReason": {
"title": "Nocaptionreason",
"type": "integer"
},
"captionInfos": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TiktokMediaVideoCaptionInfo"
}
},
"captionsType": {
"title": "Captionstype",
"type": "integer"
},
"originalLanguageInfo": {
"$ref": "#/components/schemas/TiktokMediaVideoOriginalLanguageInfo"
}
},
"x-stoplight": {
"id": "7g8zxaox19mj9"
}
},
"TiktokMediaVideo": {
"required": [
"id"
],
"type": "object",
"properties": {
"id": {
"title": "Id",
"type": "string",
"minLength": 1
},
"height": {
"title": "Height",
"type": "integer"
},
"width": {
"title": "Width",
"type": "integer"
},
"duration": {
"title": "Duration",
"type": "integer"
},
"ratio": {
"title": "Ratio",
"type": "string"
},
"cover": {
"title": "Cover",
"type": "string"
},
"originCover": {
"title": "Origincover",
"type": "string"
},
"dynamicCover": {
"title": "Dynamiccover",
"type": "string"
},
"playAddr": {
"title": "Playaddr",
"description": "It is often not possible to download the content using this URL directly. Use [TikTok Media Video Content endpoint](#operation/tt-media-video) instead to download the video content.",
"type": "string"
},
"downloadAddr": {
"title": "Downloadaddr",
"type": "string"
},
"shareCover": {
"type": "array",
"items": {
"type": "string"
}
},
"reflowCover": {
"title": "Reflowcover",
"type": "string"
},
"subtitleInfos": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TiktokMediaVideoSubtitleInfo"
}
},
"claInfo": {
"$ref": "#/components/schemas/TiktokMediaVideoClaInfo"
}
},
"x-stoplight": {
"id": "c542o66p1j9df"
}
},
"TiktokMediaAuthor": {
"required": [
"id"
],
"type": "object",
"properties": {
"id": {
"title": "Id",
"type": "string",
"minLength": 1
},
"uniqueId": {
"title": "Uniqueid",
"type": "string"
},
"nickname": {
"title": "Nickname",
"type": "string"
},
"avatarThumb": {
"title": "Avatarthumb",
"type": "string"
},
"avatarMedium": {
"title": "Avatarmedium",
"type": "string"
},
"avatarLarger": {
"title": "Avatarlarger",
"type": "string"
},
"signature": {
"title": "Signature",
"type": "string"
},
"verified": {
"title": "Verified",
"type": "boolean"
},
"secUid": {
"title": "Secuid",
"type": "string",
"minLength": 1
},
"secret": {
"title": "Secret",
"type": "boolean"
},
"ftc": {
"title": "Ftc",
"type": "boolean"
},
"openFavorite": {
"title": "Openfavorite",
"type": "boolean"
},
"commentSetting": {
"title": "Commentsetting",
"type": "integer"
},
"duetSetting": {
"title": "Duetsetting",
"type": "integer"
},
"stitchSetting": {
"title": "Stitchsetting",
"type": "integer"
},
"privateAccount": {
"title": "Privateaccount",
"type": "boolean"
}
},
"x-stoplight": {
"id": "s4u3zh7gsztfg"
}
},
"TiktokMediaMusic": {
"type": "object",
"properties": {
"id": {
"title": "Id",
"type": "string"
},
"title": {
"title": "Title",
"type": "string"
},
"playUrl": {
"title": "Playurl",
"type": "string"
},
"coverThumb": {
"title": "Coverthumb",
"type": "string"
},
"coverMedium": {
"title": "Covermedium",
"type": "string"
},
"coverLarge": {
"title": "Coverlarge",
"type": "string"
},
"authorName": {
"title": "Authorname",
"type": "string"
},
"original": {
"title": "Original",
"type": "boolean"
},
"duration": {
"title": "Duration",
"type": "integer"
},
"album": {
"title": "Album",
"type": "string"
}
},
"x-stoplight": {
"id": "a30vognt2sfvn"
}
},
"TiktokMediaTextExtra": {
"type": "object",
"properties": {
"awemeId": {
"title": "Awemeid",
"type": "string"
},
"start": {
"title": "Start",
"type": "integer"
},
"end": {
"title": "End",
"type": "integer"
},
"hashtagName": {
"title": "Hashtagname",
"type": "string"
},
"hashtagId": {
"title": "Hashtagid",
"type": "string"
},
"type": {
"title": "Type",
"type": "integer"
},
"userId": {
"title": "Userid",
"type": "string"
},
"isCommerce": {
"title": "Iscommerce",
"type": "boolean"
},
"userUniqueId": {
"title": "Useruniqueid",
"type": "string"
},
"secUid": {
"title": "Secuid",
"type": "string"
},
"questionId": {
"title": "Questionid",
"type": "string"
},
"questionContent": {
"title": "Questioncontent",
"type": "string"
},
"subType": {
"title": "Subtype",
"type": "integer"
}
},
"x-stoplight": {
"id": "x0cgvhf2bibll"
}
},
"TiktokMediaContent": {
"required": [
"desc"
],
"type": "object",
"properties": {
"desc": {
"title": "Desc",
"type": "string"
},
"textExtra": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TiktokMediaTextExtra"
}
}
},
"x-stoplight": {
"id": "m4gqjxj1mccyi"
}
},
"TiktokMediaStatsData": {
"type": "object",
"properties": {
"collectCount": {
"title": "Collectcount",
"type": "integer"
},
"diggCount": {
"title": "Diggcount",
"type": "integer"
},
"shareCount": {
"title": "Sharecount",
"type": "integer"
},
"commentCount": {
"title": "Commentcount",
"type": "integer"
},
"playCount": {
"title": "Playcount",
"type": "integer"
}
},
"x-stoplight": {
"id": "5543eutotowml"
}
},
"TiktokMediaImagePostImageUrl": {
"type": "object",
"properties": {
"urlList": {
"type": "array",
"items": {
"type": "string"
}
}
},
"x-stoplight": {
"id": "l9bsmst5gbmq5"
}
},
"TiktokMediaImagePostImage": {
"required": [
"imageHeight",
"imageURL",
"imageWidth"
],
"type": "object",
"properties": {
"imageHeight": {
"title": "Imageheight",
"type": "integer"
},
"imageURL": {
"$ref": "#/components/schemas/TiktokMediaImagePostImageUrl"
},
"imageWidth": {
"title": "Imagewidth",
"type": "integer"
}
},
"x-stoplight": {
"id": "lsvx5xs7p74pa"
}
},
"TiktokMediaImagePost": {
"required": [
"cover",
"images"
],
"type": "object",
"properties": {
"cover": {
"$ref": "#/components/schemas/TiktokMediaImagePostImage"
},
"images": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TiktokMediaImagePostImage"
},
"minItems": 1
},
"title": {
"title": "Title",
"type": "string"
}
},
"x-stoplight": {
"id": "76pkmzaz9r92e"
}
},
"TiktokUserStats": {
"type": "object",
"properties": {
"followingCount": {
"title": "Followingcount",
"type": "integer"
},
"followerCount": {
"title": "Followercount",
"type": "integer"
},
"heartCount": {
"title": "Heartcount",
"type": "integer"
},
"videoCount": {
"title": "Videocount",
"type": "integer"
},
"diggCount": {
"title": "Diggcount",
"type": "integer"
},
"heart": {
"title": "Heart",
"type": "integer"
}
},
"x-stoplight": {
"id": "o2bj4o47fdqqw"
}
},
"TiktokFeedMediaChallenge": {
"required": [
"id"
],
"type": "object",
"properties": {
"id": {
"title": "Id",
"type": "string",
"minLength": 1
},
"title": {
"title": "Title",
"type": "string",
"minLength": 1
},
"desc": {
"title": "Desc",
"type": "string"
},
"profileThumb": {
"title": "Profilethumb",
"type": "string"
},
"profileMedium": {
"title": "Profilemedium",
"type": "string"
},
"profileLarger": {
"title": "Profilelarger",
"type": "string"
},
"coverThumb": {
"title": "Coverthumb",
"type": "string"
},
"coverMedium": {
"title": "Covermedium",
"type": "string"
},
"coverLarger": {
"title": "Coverlarger",
"type": "string"
}
},
"x-stoplight": {
"id": "yio570we0seo7"
}
},
"TiktokFeedMediaEffectSticker": {
"required": [
"ID"
],
"type": "object",
"properties": {
"name": {
"title": "Name",
"type": "string"
},
"ID": {
"title": "Id",
"type": "string",
"minLength": 1
}
},
"x-stoplight": {
"id": "h0u2jz143aqun"
}
},
"TiktokFeedMediaStickerOnItem": {
"type": "object",
"properties": {
"stickerText": {
"type": "array",
"items": {
"type": "string"
}
},
"stickerType": {
"title": "Stickertype",
"type": "integer"
}
},
"x-stoplight": {
"id": "wkl11ot4aul46"
}
},
"TiktokFeedItem": {
"required": [
"id"
],
"type": "object",
"properties": {
"id": {
"title": "Id",
"type": "string",
"minLength": 1
},
"desc": {
"title": "Desc",
"type": "string"
},
"createTime": {
"title": "Createtime",
"type": "integer"
},
"video": {
"$ref": "#/components/schemas/TiktokMediaVideo"
},
"author": {
"$ref": "#/components/schemas/TiktokMediaAuthor"
},
"music": {
"$ref": "#/components/schemas/TiktokMediaMusic"
},
"contents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TiktokMediaContent"
}
},
"stats": {
"$ref": "#/components/schemas/TiktokMediaStatsData"
},
"textExtra": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TiktokMediaTextExtra"
}
},
"secret": {
"title": "Secret",
"type": "boolean"
},
"showNotPass": {
"title": "Shownotpass",
"type": "boolean"
},
"vl1": {
"title": "Vl1",
"type": "boolean"
},
"imagePost": {
"$ref": "#/components/schemas/TiktokMediaImagePost"
},
"itemMute": {
"title": "Itemmute",
"type": "boolean"
},
"authorStats": {
"$ref": "#/components/schemas/TiktokUserStats"
},
"privateItem": {
"title": "Privateitem",
"type": "boolean"
},
"duetEnabled": {
"title": "Duetenabled",
"type": "boolean"
},
"stitchEnabled": {
"title": "Stitchenabled",
"type": "boolean"
},
"shareEnabled": {
"title": "Shareenabled",
"type": "boolean"
},
"itemCommentStatus": {
"title": "Itemcommentstatus",
"description": "Value `3` means that comments for this post are turned off by the author. [Comments](#operation/tt-comments) endpoint returns `unavailable` error for such post.",
"type": "integer"
},
"isAd": {
"title": "Isad",
"description": "To determine whether a post includes a Partnership tag, check the adLabelVersion field.",
"type": "boolean"
},
"adLabelVersion": {
"title": "Adlabelversion",
"description": "Enum: 1,2; 2 means the post is marked with a Paid Partnership tag",
"type": "integer"
},
"AnchorTypes": {
"type": "array",
"items": {
"type": "integer"
}
},
"isPinnedItem": {
"title": "Ispinneditem",
"type": "boolean"
},
"challenges": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TiktokFeedMediaChallenge"
}
},
"originalItem": {
"title": "Originalitem",
"type": "boolean"
},
"officalItem": {
"title": "Officalitem",
"type": "boolean"
},
"forFriend": {
"title": "Forfriend",
"type": "boolean"
},
"effectStickers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TiktokFeedMediaEffectSticker"
}
},
"stickersOnItem": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TiktokFeedMediaStickerOnItem"
}
}
},
"x-stoplight": {
"id": "grmiccnszv12b"
}
},
"TiktokChallengeFeed": {
"required": [
"hasMore",
"cursor"
],
"type": "object",
"properties": {
"itemList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TiktokFeedItem"
}
},
"hasMore": {
"title": "Hasmore",
"type": "boolean"
},
"cursor": {
"title": "Cursor",
"type": "string",
"minLength": 1
}
},
"x-stoplight": {
"id": "xcehfb5dw9pqy"
}
},
"TiktokChallengeFeedResponse": {
"required": [
"success",
"challenge_feed"
],
"type": "object",
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"challenge_feed": {
"$ref": "#/components/schemas/TiktokChallengeFeed"
}
},
"x-stoplight": {
"id": "ft0eslpzm9bly"
}
},
"TiktokChallengeInfoChallenge": {
"required": [
"id",
"title",
"desc",
"profileLarger",
"profileMedium",
"profileThumb",
"coverLarger",
"coverMedium",
"coverThumb",
"isCommerce"
],
"type": "object",
"properties": {
"id": {
"title": "Id",
"type": "string",
"minLength": 1
},
"title": {
"title": "Title",
"type": "string",
"minLength": 1
},
"desc": {
"title": "Desc",
"type": "string"
},
"profileLarger": {
"title": "Profilelarger",
"type": "string"
},
"profileMedium": {
"title": "Profilemedium",
"type": "string"
},
"profileThumb": {
"title": "Profilethumb",
"type": "string"
},
"coverLarger": {
"title": "Coverlarger",
"type": "string"
},
"coverMedium": {
"title": "Covermedium",
"type": "string"
},
"coverThumb": {
"title": "Coverthumb",
"type": "string"
},
"isCommerce": {
"title": "Iscommerce",
"type": "boolean"
},
"splitTitle": {
"title": "Splittitle",
"type": "string",
"minLength": 1
}
},
"x-stoplight": {
"id": "v2dviafqyv2t8"
}
},
"TiktokChallengeInfoStatsSerailizer": {
"required": [
"videoCount",
"viewCount"
],
"type": "object",
"properties": {
"videoCount": {
"title": "Videocount",
"type": "integer"
},
"viewCount": {
"title": "Viewcount",
"type": "integer"
}
},
"x-stoplight": {
"id": "8oe6hq860xgu7"
}
},
"TiktokChallengeInfoData": {
"required": [
"challenge",
"stats"
],
"type": "object",
"properties": {
"challenge": {
"$ref": "#/components/schemas/TiktokChallengeInfoChallenge"
},
"stats": {
"$ref": "#/components/schemas/TiktokChallengeInfoStatsSerailizer"
}
},
"x-stoplight": {
"id": "h0qtwm6ic47ti"
}
},
"TiktokChallengeInfo": {
"required": [
"challengeInfo"
],
"type": "object",
"properties": {
"challengeInfo": {
"$ref": "#/components/schemas/TiktokChallengeInfoData"
}
},
"x-stoplight": {
"id": "vgyjgr66tqp9c"
}
},
"TiktokChallengeInfoResponse": {
"required": [
"success",
"challenge"
],
"type": "object",
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"challenge": {
"$ref": "#/components/schemas/TiktokChallengeInfo"
}
},
"x-stoplight": {
"id": "94jvnbbx0etjj"
}
},
"TiktokCommentUserAvatarThumb": {
"type": "object",
"properties": {
"uri": {
"title": "Uri",
"type": "string",
"minLength": 1
},
"url_list": {
"type": "array",
"items": {
"type": "string"
}
}
},
"x-stoplight": {
"id": "rbg9xqhgjz1tt"
}
},
"TiktokCommentUser": {
"required": [
"sec_uid"
],
"type": "object",
"properties": {
"uid": {
"title": "Uid",
"type": "string",
"minLength": 1
},
"nickname": {
"title": "Nickname",
"type": "string"
},
"avatar_thumb": {
"$ref": "#/components/schemas/TiktokCommentUserAvatarThumb"
},
"custom_verify": {
"title": "Custom verify",
"type": "string"
},
"unique_id": {
"title": "Unique id",
"type": "string"
},
"enterprise_verify_reason": {
"title": "Enterprise verify reason",
"type": "string"
},
"sec_uid": {
"title": "Sec uid",
"type": "string",
"minLength": 1
}
},
"x-stoplight": {
"id": "43h64ovl8g4n7"
}
},
"TiktokCommentTextExtra": {
"type": "object",
"properties": {
"start": {
"title": "Start",
"type": "integer"
},
"end": {
"title": "End",
"type": "integer"
},
"user_id": {
"title": "User id",
"type": "string"
},
"hashtag_name": {
"title": "Hashtag name",
"type": "string"
},
"hashtag_id": {
"title": "Hashtag id",
"type": "string"
},
"sec_uid": {
"title": "Sec uid",
"type": "string"
}
},
"x-stoplight": {
"id": "uauf7x06p92ft"
}
},
"TiktokCommentReply": {
"required": [
"cid",
"text",
"user"
],
"type": "object",
"properties": {
"cid": {
"title": "Cid",
"type": "string",
"minLength": 1
},
"text": {
"title": "Text",
"type": "string"
},
"aweme_id": {
"title": "Aweme id",
"type": "string",
"minLength": 1
},
"create_time": {
"title": "Create time",
"type": "integer"
},
"digg_count": {
"title": "Digg count",
"type": "integer"
},
"status": {
"title": "Status",
"type": "integer"
},
"user": {
"$ref": "#/components/schemas/TiktokCommentUser"
},
"reply_id": {
"title": "Reply id",
"type": "string",
"minLength": 1
},
"text_extra": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TiktokCommentTextExtra"
}
},
"label_text": {
"title": "Label text",
"type": "string"
},
"label_type": {
"title": "Label type",
"type": "integer"
},
"reply_comment_total": {
"title": "Reply comment total",
"type": "integer"
},
"reply_to_reply_id": {
"title": "Reply to reply id",
"type": "string",
"minLength": 1
},
"reply_to_userid": {
"title": "Reply to userid",
"type": "string",
"minLength": 1
},
"reply_to_username": {
"title": "Reply to username",
"type": "string",
"minLength": 1
},
"is_author_digged": {
"title": "Is author digged",
"type": "boolean"
}
},
"x-stoplight": {
"id": "zszathg1wgi2h"
}
},
"TiktokComment": {
"required": [
"cid",
"text",
"user"
],
"type": "object",
"properties": {
"cid": {
"title": "Cid",
"type": "string",
"minLength": 1
},
"text": {
"title": "Text",
"type": "string"
},
"aweme_id": {
"title": "Aweme id",
"type": "string",
"minLength": 1
},
"create_time": {
"title": "Create time",
"type": "integer"
},
"digg_count": {
"title": "Digg count",
"type": "integer"
},
"status": {
"title": "Status",
"type": "integer"
},
"user": {
"$ref": "#/components/schemas/TiktokCommentUser"
},
"reply_id": {
"title": "Reply id",
"type": "string",
"minLength": 1
},
"text_extra": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TiktokCommentTextExtra"
}
},
"label_text": {
"title": "Label text",
"type": "string"
},
"label_type": {
"title": "Label type",
"type": "integer"
},
"reply_comment_total": {
"title": "Reply comment total",
"type": "integer"
},
"reply_to_reply_id": {
"title": "Reply to reply id",
"type": "string",
"minLength": 1
},
"reply_to_userid": {
"title": "Reply to userid",
"type": "string",
"minLength": 1
},
"reply_to_username": {
"title": "Reply to username",
"type": "string",
"minLength": 1
},
"is_author_digged": {
"title": "Is author digged",
"type": "boolean"
},
"reply_comment": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TiktokCommentReply"
},
"nullable": true
}
},
"x-stoplight": {
"id": "jc3mmpt5eshi2"
}
},
"TiktokComments": {
"required": [
"cursor",
"has_more",
"total"
],
"type": "object",
"properties": {
"comments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TiktokComment"
},
"nullable": true
},
"cursor": {
"title": "Cursor",
"type": "integer"
},
"has_more": {
"title": "Has more",
"type": "integer"
},
"reply_style": {
"title": "Reply style",
"type": "integer"
},
"total": {
"title": "Total",
"type": "integer"
}
},
"x-stoplight": {
"id": "5m3jf0v086ty0"
}
},
"TiktokCommentsResponse": {
"required": [
"success",
"comments"
],
"type": "object",
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"comments": {
"$ref": "#/components/schemas/TiktokComments"
}
},
"x-stoplight": {
"id": "ylvpwcboz2qgf"
}
},
"TiktokMusicFeed": {
"required": [
"hasMore",
"cursor"
],
"type": "object",
"properties": {
"itemList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TiktokFeedItem"
}
},
"hasMore": {
"title": "Hasmore",
"type": "boolean"
},
"cursor": {
"title": "Cursor",
"type": "string",
"minLength": 1
}
},
"x-stoplight": {
"id": "v2tmaxibyp683"
}
},
"TiktokMusicFeedResponse": {
"required": [
"success",
"music_feed"
],
"type": "object",
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"music_feed": {
"$ref": "#/components/schemas/TiktokMusicFeed"
}
},
"x-stoplight": {
"id": "11zpkdw7vxy4q"
}
},
"TiktokMusicStats": {
"required": [
"videoCount"
],
"type": "object",
"properties": {
"videoCount": {
"title": "Videocount",
"type": "integer"
}
},
"x-stoplight": {
"id": "nsdxig45ontsk"
}
},
"TiktokMusicInfoData": {
"required": [
"music",
"stats"
],
"type": "object",
"properties": {
"music": {
"$ref": "#/components/schemas/TiktokMediaMusic"
},
"author": {
"$ref": "#/components/schemas/TiktokMediaAuthor"
},
"stats": {
"$ref": "#/components/schemas/TiktokMusicStats"
},
"artist": {
"$ref": "#/components/schemas/TiktokMediaAuthor"
},
"artists": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TiktokMediaAuthor"
}
}
},
"x-stoplight": {
"id": "qls6tl5cpdp5v"
}
},
"TiktokMusicInfo": {
"required": [
"musicInfo"
],
"type": "object",
"properties": {
"musicInfo": {
"$ref": "#/components/schemas/TiktokMusicInfoData"
}
},
"x-stoplight": {
"id": "tdywvq2ddpsws"
}
},
"TiktokMusicInfoResponse": {
"required": [
"success",
"music"
],
"type": "object",
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"music": {
"$ref": "#/components/schemas/TiktokMusicInfo"
}
},
"x-stoplight": {
"id": "cozq48aji200h"
}
},
"TiktokResolvedShortlink": {
"required": [
"type"
],
"type": "object",
"properties": {
"type": {
"title": "Type",
"description": "Type of the entity this shortlink leads to",
"type": "string",
"enum": [
"USER",
"USERNAME",
"POST",
"MUSIC",
"LIVE",
"TAG",
"STICKER",
"TIKTOK_VM",
"TIKTOK_VT",
"TIKTOK_WWWT",
"OTHER"
]
},
"userId": {
"title": "Userid",
"description": "For `type=USER`",
"type": "string",
"minLength": 1,
"nullable": true
},
"username": {
"title": "Username",
"description": "For `type=USERNAME`",
"type": "string",
"minLength": 1,
"nullable": true
},
"postId": {
"title": "Postid",
"description": "For `type=POST`",
"type": "string",
"minLength": 1,
"nullable": true
},
"musicId": {
"title": "Musicid",
"description": "For `type=MUSIC`",
"type": "string",
"minLength": 1,
"nullable": true
},
"liveId": {
"title": "Liveid",
"description": "For `type=LIVE`",
"type": "string",
"minLength": 1,
"nullable": true
},
"tagId": {
"title": "Tagid",
"description": "For `type=TAG`",
"type": "string",
"minLength": 1,
"nullable": true
},
"stickerId": {
"title": "Stickerid",
"description": "For `type=STICKER`",
"type": "string",
"minLength": 1,
"nullable": true
},
"shortcode": {
"title": "Shortcode",
"description": "For `type=TIKTOK_VM`, `type=TIKTOK_VT` and `type=TIKTOK_WWWT`. Rarely, shortlink can lead to another shortlink. Contains shortcode of the target URL, e.g. `type=TIKTOK_VM` and `shortcode=AbCd` means current shortlink leads to `https://vm.tiktok.com/AbCd/`",
"type": "string",
"minLength": 1,
"nullable": true
},
"location": {
"title": "Location",
"description": "For `type=OTHER`, `type=TIKTOK_VM`, `type=TIKTOK_VT` and `type=TIKTOK_WWWT`. Contains URL where current shortlink leads to. VM/VT/WWWT are explained above. Links with `type=OTHER` usually lead to promotion or info pages, not related to any specific entity (post / user / etc.)",
"type": "string",
"minLength": 1,
"nullable": true
}
},
"x-stoplight": {
"id": "dhhyhjp0qg6sl"
}
},
"TiktokResolvedShortlinkResponse": {
"required": [
"success",
"shortlink"
],
"type": "object",
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"shortlink": {
"$ref": "#/components/schemas/TiktokResolvedShortlink"
}
},
"x-stoplight": {
"id": "y23h4ufouhymb"
}
},
"TiktokSearchUserAvatarThumb": {
"type": "object",
"properties": {
"uri": {
"title": "Uri",
"type": "string",
"minLength": 1
},
"url_list": {
"type": "array",
"items": {
"type": "string"
}
},
"width": {
"title": "Width",
"type": "integer"
},
"height": {
"title": "Height",
"type": "integer"
}
},
"x-stoplight": {
"id": "k8milzlo5i6a7"
}
},
"TiktokSearchUserInfo": {
"required": [
"uid",
"avatar_thumb",
"follower_count",
"sec_uid"
],
"type": "object",
"properties": {
"uid": {
"title": "Uid",
"type": "string",
"minLength": 1
},
"nickname": {
"title": "Nickname",
"type": "string",
"minLength": 1
},
"signature": {
"title": "Signature",
"type": "string"
},
"avatar_thumb": {
"$ref": "#/components/schemas/TiktokSearchUserAvatarThumb"
},
"follower_count": {
"title": "Follower count",
"type": "integer"
},
"custom_verify": {
"title": "Custom verify",
"type": "string"
},
"unique_id": {
"title": "Unique id",
"type": "string",
"minLength": 1
},
"enterprise_verify_reason": {
"title": "Enterprise verify reason",
"type": "string"
},
"sec_uid": {
"title": "Sec uid",
"type": "string",
"minLength": 1
}
},
"x-stoplight": {
"id": "bjc31or2fid8h"
}
},
"TiktokSearchUser": {
"required": [
"user_info"
],
"type": "object",
"properties": {
"user_info": {
"$ref": "#/components/schemas/TiktokSearchUserInfo"
}
},
"x-stoplight": {
"id": "dq9rx1dbh247e"
}
},
"TiktokSearchUsersResult": {
"required": [
"input_keyword"
],
"type": "object",
"properties": {
"user_list": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TiktokSearchUser"
}
},
"input_keyword": {
"title": "Input keyword",
"type": "string"
}
},
"x-stoplight": {
"id": "hls43w0yffe1r"
}
},
"TiktokSearchUsersResponse": {
"required": [
"success",
"result"
],
"type": "object",
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"result": {
"$ref": "#/components/schemas/TiktokSearchUsersResult"
}
},
"x-stoplight": {
"id": "kcejfx7zpmdef"
}
},
"TiktokUserFeed": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TiktokFeedItem"
}
},
"hasMore": {
"title": "Hasmore",
"type": "boolean"
},
"maxCursor": {
"title": "Maxcursor",
"type": "string",
"minLength": 1
}
},
"x-stoplight": {
"id": "xjhtf8qn0liz3"
}
},
"TiktokUserFeedResponse": {
"required": [
"success",
"user_feed"
],
"type": "object",
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"user_feed": {
"$ref": "#/components/schemas/TiktokUserFeed"
}
},
"x-stoplight": {
"id": "wn7ty96olbht2"
}
},
"TiktokBioLinkData": {
"type": "object",
"properties": {
"link": {
"title": "Link",
"type": "string",
"minLength": 1
},
"risk": {
"title": "Risk",
"type": "integer"
}
},
"x-stoplight": {
"id": "n5wfobkx6pj1w"
}
},
"CommerceUserInfo": {
"required": [
"commerceUser"
],
"type": "object",
"properties": {
"commerceUser": {
"title": "Commerceuser",
"type": "boolean"
},
"category": {
"title": "Category",
"type": "string"
}
},
"x-stoplight": {
"id": "5k4vbqdi0kdvk"
}
},
"TiktokUserData": {
"required": [
"id",
"uniqueId",
"secUid"
],
"type": "object",
"properties": {
"id": {
"title": "Id",
"type": "string",
"minLength": 1
},
"uniqueId": {
"title": "Uniqueid",
"type": "string"
},
"nickname": {
"title": "Nickname",
"type": "string"
},
"avatarThumb": {
"title": "Avatarthumb",
"type": "string"
},
"avatarMedium": {
"title": "Avatarmedium",
"type": "string"
},
"avatarLarger": {
"title": "Avatarlarger",
"type": "string"
},
"signature": {
"title": "Signature",
"type": "string"
},
"verified": {
"title": "Verified",
"type": "boolean"
},
"secUid": {
"title": "Secuid",
"type": "string",
"minLength": 1
},
"createTime": {
"title": "Createtime",
"type": "integer"
},
"secret": {
"title": "Secret",
"type": "boolean"
},
"ftc": {
"title": "Ftc",
"type": "boolean"
},
"openFavorite": {
"title": "Openfavorite",
"type": "boolean"
},
"bioLink": {
"$ref": "#/components/schemas/TiktokBioLinkData"
},
"privateAccount": {
"title": "Privateaccount",
"type": "boolean"
},
"commerceUserInfo": {
"$ref": "#/components/schemas/CommerceUserInfo"
}
},
"x-stoplight": {
"id": "s0plwucxeoxl1"
}
},
"TiktokShareMeta": {
"type": "object",
"properties": {
"title": {
"title": "Title",
"type": "string",
"minLength": 1
},
"desc": {
"title": "Desc",
"type": "string",
"minLength": 1
}
},
"x-stoplight": {
"id": "foworq8lr6mzi"
}
},
"TiktokUserInfoData": {
"required": [
"user",
"stats"
],
"type": "object",
"properties": {
"user": {
"$ref": "#/components/schemas/TiktokUserData"
},
"stats": {
"$ref": "#/components/schemas/TiktokUserStats"
},
"shareMeta": {
"$ref": "#/components/schemas/TiktokShareMeta"
}
},
"x-stoplight": {
"id": "1jwxqnt8twjhp"
}
},
"TiktokUserInfo": {
"required": [
"userInfo"
],
"type": "object",
"properties": {
"userInfo": {
"$ref": "#/components/schemas/TiktokUserInfoData"
}
},
"x-stoplight": {
"id": "aannu1kub4jzi"
}
},
"TiktokUserInfoResponse": {
"required": [
"success",
"user_info"
],
"type": "object",
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"user_info": {
"$ref": "#/components/schemas/TiktokUserInfo"
}
},
"x-stoplight": {
"id": "vvdcbt0k6d3j3"
}
},
"TiktokMediaChallenge": {
"required": [
"id"
],
"type": "object",
"properties": {
"id": {
"title": "Id",
"type": "string",
"minLength": 1
},
"title": {
"title": "Title",
"type": "string",
"minLength": 1
},
"desc": {
"title": "Desc",
"type": "string"
},
"profileThumb": {
"title": "Profilethumb",
"type": "string"
},
"profileMedium": {
"title": "Profilemedium",
"type": "string"
},
"profileLarger": {
"title": "Profilelarger",
"type": "string"
},
"coverThumb": {
"title": "Coverthumb",
"type": "string"
},
"coverMedium": {
"title": "Covermedium",
"type": "string"
},
"coverLarger": {
"title": "Coverlarger",
"type": "string"
},
"isCommerce": {
"title": "Iscommerce",
"type": "boolean"
}
},
"x-stoplight": {
"id": "pcnioqyl5p92k"
}
},
"TiktokMediaDuetInfo": {
"type": "object",
"properties": {
"duetFromId": {
"title": "Duetfromid",
"type": "string",
"minLength": 1
}
},
"x-stoplight": {
"id": "3w92n7oq54sjm"
}
},
"TiktokMediaStickerOnItem": {
"type": "object",
"properties": {
"stickerType": {
"title": "Stickertype",
"type": "integer"
},
"stickerText": {
"type": "array",
"items": {
"type": "string"
}
}
},
"x-stoplight": {
"id": "5610ca90wm3nk"
}
},
"TiktokItemStruct": {
"required": [
"id"
],
"type": "object",
"properties": {
"id": {
"title": "Id",
"type": "string",
"minLength": 1
},
"desc": {
"title": "Desc",
"type": "string"
},
"createTime": {
"title": "Createtime",
"type": "integer"
},
"video": {
"$ref": "#/components/schemas/TiktokMediaVideo"
},
"author": {
"$ref": "#/components/schemas/TiktokMediaAuthor"
},
"music": {
"$ref": "#/components/schemas/TiktokMediaMusic"
},
"contents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TiktokMediaContent"
}
},
"stats": {
"$ref": "#/components/schemas/TiktokMediaStatsData"
},
"textExtra": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TiktokMediaTextExtra"
}
},
"secret": {
"title": "Secret",
"type": "boolean"
},
"showNotPass": {
"title": "Shownotpass",
"type": "boolean"
},
"vl1": {
"title": "Vl1",
"type": "boolean"
},
"imagePost": {
"$ref": "#/components/schemas/TiktokMediaImagePost"
},
"itemMute": {
"title": "Itemmute",
"type": "boolean"
},
"authorStats": {
"$ref": "#/components/schemas/TiktokUserStats"
},
"privateItem": {
"title": "Privateitem",
"type": "boolean"
},
"duetEnabled": {
"title": "Duetenabled",
"type": "boolean"
},
"stitchEnabled": {
"title": "Stitchenabled",
"type": "boolean"
},
"shareEnabled": {
"title": "Shareenabled",
"type": "boolean"
},
"itemCommentStatus": {
"title": "Itemcommentstatus",
"description": "Value `3` means that comments for this post are turned off by the author. [Comments](#operation/tt-comments) endpoint returns `unavailable` error for such post.",
"type": "integer"
},
"isAd": {
"title": "Isad",
"description": "To determine whether a post includes a Partnership tag, check the adLabelVersion field.",
"type": "boolean"
},
"adLabelVersion": {
"title": "Adlabelversion",
"description": "Enum: 1,2; 2 means the post is marked with a Paid Partnership tag",
"type": "integer"
},
"AnchorTypes": {
"type": "array",
"items": {
"type": "integer"
}
},
"challenges": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TiktokMediaChallenge"
}
},
"isActivityItem": {
"title": "Isactivityitem",
"type": "boolean"
},
"duetInfo": {
"$ref": "#/components/schemas/TiktokMediaDuetInfo"
},
"stickersOnItem": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TiktokMediaStickerOnItem"
}
}
},
"x-stoplight": {
"id": "g6agh31byo35h"
}
},
"TiktokItemInfo": {
"required": [
"itemStruct"
],
"type": "object",
"properties": {
"itemStruct": {
"$ref": "#/components/schemas/TiktokItemStruct"
},
"shareMeta": {
"$ref": "#/components/schemas/TiktokShareMeta"
}
},
"x-stoplight": {
"id": "1nhut4xbrxajm"
}
},
"TiktokMediaInfo": {
"required": [
"itemInfo"
],
"type": "object",
"properties": {
"itemInfo": {
"$ref": "#/components/schemas/TiktokItemInfo"
}
},
"x-stoplight": {
"id": "kg792e7ung7mg"
}
},
"TiktokMediaInfoResponse": {
"required": [
"success",
"media"
],
"type": "object",
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"media": {
"$ref": "#/components/schemas/TiktokMediaInfo"
}
},
"x-stoplight": {
"id": "m1hquabhxep7l"
}
},
"YouTubeChannelInfoData": {
"required": [
"channel_id",
"is_removed",
"is_hidden",
"is_verified"
],
"type": "object",
"properties": {
"channel_id": {
"title": "Channel id",
"type": "string",
"minLength": 1
},
"custom_url": {
"title": "Custom url",
"type": "string",
"minLength": 1
},
"username": {
"title": "Username",
"type": "string",
"minLength": 1
},
"handle": {
"title": "Handle",
"type": "string",
"minLength": 1
},
"is_removed": {
"title": "Is removed",
"type": "boolean"
},
"is_hidden": {
"title": "Is hidden",
"type": "boolean"
},
"is_verified": {
"title": "Is verified",
"type": "boolean"
},
"fullname": {
"title": "Fullname",
"type": "string"
},
"picture": {
"title": "Picture",
"type": "string",
"format": "uri",
"minLength": 1
},
"description": {
"title": "Description",
"type": "string"
},
"country": {
"title": "Country",
"type": "string"
},
"followers": {
"title": "Followers",
"type": "integer"
},
"joined_at": {
"title": "Joined at",
"type": "string",
"format": "date-time"
},
"total_views": {
"title": "Total views",
"type": "integer"
},
"links": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
},
"channel_video_count": {
"title": "Channel video count",
"type": "integer"
}
},
"x-stoplight": {
"id": "worqx94ms4pbc"
}
},
"YouTubeChannelInfoResponse": {
"required": [
"success"
],
"type": "object",
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"channel_info": {
"$ref": "#/components/schemas/YouTubeChannelInfoData"
}
},
"x-stoplight": {
"id": "fsf6d77mckagh"
}
},
"YouTubePlaylistInfo": {
"required": [
"playlist_id",
"title",
"thumbnail",
"total_videos"
],
"type": "object",
"properties": {
"playlist_id": {
"title": "Playlist id",
"type": "string",
"minLength": 1
},
"title": {
"title": "Title",
"type": "string",
"minLength": 1
},
"thumbnail": {
"title": "Thumbnail",
"type": "string",
"minLength": 1
},
"total_videos": {
"title": "Total videos",
"type": "integer"
}
},
"x-stoplight": {
"id": "w165gebpkpm3b"
}
},
"YouTubePlaylists": {
"required": [
"playlists"
],
"type": "object",
"properties": {
"playlists": {
"type": "array",
"items": {
"$ref": "#/components/schemas/YouTubePlaylistInfo"
}
},
"cursor": {
"title": "Cursor",
"type": "string",
"minLength": 1,
"nullable": true
}
},
"x-stoplight": {
"id": "pgpzzksd1e6lu"
}
},
"YouTubePlaylistsResponse": {
"required": [
"success",
"playlists_list"
],
"type": "object",
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"playlists_list": {
"$ref": "#/components/schemas/YouTubePlaylists"
}
},
"x-stoplight": {
"id": "qsgu9e98bv7sn"
}
},
"YouTubeChannelVideosRequestBody": {
"type": "object",
"properties": {
"after": {
"title": "After",
"description": "For pagination pass content of ```cursor``` field from the last response to get next page.",
"type": "string",
"minLength": 1
}
},
"x-stoplight": {
"id": "ssz2sr7e8gdqm"
}
},
"YouTubeVideoItemData": {
"type": "object",
"properties": {
"video_id": {
"title": "Video id",
"type": "string",
"minLength": 1
},
"thumbnail": {
"title": "Thumbnail",
"type": "string",
"minLength": 1
},
"title": {
"title": "Title",
"type": "string"
},
"time": {
"title": "Time",
"type": "string",
"minLength": 1
},
"published_ago": {
"title": "Published ago",
"type": "string",
"minLength": 1
},
"views": {
"title": "Views",
"type": "integer"
}
},
"nullable": true,
"x-stoplight": {
"id": "upg7vauocwnw4"
}
},
"YouTubeChannelVideoListData": {
"required": [
"videos"
],
"type": "object",
"properties": {
"videos": {
"type": "array",
"items": {
"$ref": "#/components/schemas/YouTubeVideoItemData"
},
"nullable": true
},
"cursor": {
"title": "Cursor",
"type": "string",
"readOnly": true,
"nullable": true
}
},
"x-stoplight": {
"id": "ze6066aewio1a"
}
},
"YouTubeChannelVideoListResponseData": {
"required": [
"success"
],
"type": "object",
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"videos_list": {
"$ref": "#/components/schemas/YouTubeChannelVideoListData"
}
},
"x-stoplight": {
"id": "ecups5b2ca354"
}
},
"PlaylistVideoItemData": {
"required": [
"video_id",
"title"
],
"type": "object",
"properties": {
"video_id": {
"title": "Video id",
"type": "string",
"minLength": 1
},
"thumbnail": {
"title": "Thumbnail",
"type": "string",
"minLength": 1
},
"title": {
"title": "Title",
"type": "string"
},
"time": {
"title": "Time",
"type": "string",
"minLength": 1
}
},
"x-stoplight": {
"id": "z7admmda4urgs"
}
},
"PlayListData": {
"required": [
"total",
"videos"
],
"type": "object",
"properties": {
"total": {
"title": "Total",
"type": "integer"
},
"videos": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PlaylistVideoItemData"
},
"nullable": true
},
"cursor": {
"title": "Cursor",
"type": "string",
"readOnly": true,
"nullable": true
}
},
"x-stoplight": {
"id": "gyuswufui8xpb"
}
},
"PlayListResponse": {
"required": [
"success"
],
"type": "object",
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"videos_list": {
"$ref": "#/components/schemas/PlayListData"
}
},
"x-stoplight": {
"id": "n9jyz5xy4yhdv"
}
},
"HashtagFeedRequestBody": {
"type": "object",
"properties": {
"after": {
"title": "After",
"description": "For pagination pass content of ```cursor``` field from the last response to get next page.",
"type": "string",
"minLength": 1
}
},
"x-stoplight": {
"id": "hn9wo8rt7t2tt"
}
},
"HashtagFeedVideo": {
"required": [
"video_id",
"thumbnail",
"views"
],
"type": "object",
"properties": {
"video_id": {
"title": "Video id",
"type": "string",
"minLength": 1
},
"thumbnail": {
"title": "Thumbnail",
"type": "string",
"minLength": 1
},
"views": {
"title": "Views",
"type": "integer"
},
"author_picture": {
"title": "Author picture",
"type": "string",
"minLength": 1,
"nullable": true
},
"author_channel_id": {
"title": "Author channel id",
"type": "string",
"minLength": 1,
"nullable": true
},
"title": {
"title": "Title",
"type": "string",
"minLength": 1,
"nullable": true
},
"time": {
"title": "Time",
"type": "string",
"minLength": 1,
"nullable": true
},
"published_ago": {
"title": "Published ago",
"type": "string",
"minLength": 1,
"nullable": true
},
"author_name": {
"title": "Author name",
"type": "string",
"minLength": 1,
"nullable": true
},
"is_author_official_artist": {
"title": "Is author official artist",
"type": "boolean"
},
"is_author_verified": {
"title": "Is author verified",
"type": "boolean"
}
},
"x-stoplight": {
"id": "k5ojc6du7u4xc"
}
},
"HashtagFeedList": {
"required": [
"videos"
],
"type": "object",
"properties": {
"videos": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HashtagFeedVideo"
},
"nullable": true
},
"cursor": {
"title": "Cursor",
"type": "string",
"readOnly": true,
"nullable": true
}
},
"x-stoplight": {
"id": "d3gubxlb39exl"
}
},
"HashtagFeedResponse": {
"required": [
"success"
],
"type": "object",
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"videos_list": {
"$ref": "#/components/schemas/HashtagFeedList"
}
},
"x-stoplight": {
"id": "7lbue33md7o7a"
}
},
"YouTubeHashtagInfoData": {
"required": [
"hashtag",
"videos_count",
"channel_count"
],
"type": "object",
"properties": {
"hashtag": {
"title": "Hashtag",
"type": "string",
"minLength": 1
},
"videos_count": {
"title": "Videos count",
"type": "integer"
},
"channel_count": {
"title": "Channel count",
"type": "integer"
}
},
"x-stoplight": {
"id": "km695mxkap389"
}
},
"YouTubeHashtagInfoResponse": {
"required": [
"success",
"hashtag_info"
],
"type": "object",
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"hashtag_info": {
"$ref": "#/components/schemas/YouTubeHashtagInfoData"
}
},
"x-stoplight": {
"id": "mulukib7qgebu"
}
},
"YouTubeSubtitles": {
"required": [
"vss_id",
"language_code",
"name"
],
"type": "object",
"properties": {
"vss_id": {
"title": "Vss id",
"type": "string",
"minLength": 1
},
"language_code": {
"title": "Language code",
"type": "string",
"minLength": 1
},
"name": {
"title": "Name",
"type": "string",
"minLength": 1
},
"fetch_url": {
"title": "Fetch url",
"type": "string",
"minLength": 1
}
},
"x-stoplight": {
"id": "yornvrmjbrhr1"
}
},
"YouTubeCommentsTab": {
"required": [
"type",
"cursor"
],
"type": "object",
"properties": {
"type": {
"title": "Type",
"type": "string",
"enum": [
"top",
"newest"
]
},
"cursor": {
"title": "Cursor",
"type": "string",
"minLength": 1
}
},
"x-stoplight": {
"id": "zhd7nrgh6eozu"
}
},
"YouTubeVideoInfoData": {
"required": [
"video_id",
"channel_id",
"title",
"published_at",
"genre",
"thumbnail"
],
"type": "object",
"properties": {
"video_id": {
"title": "Video id",
"type": "string",
"minLength": 1
},
"channel_id": {
"title": "Channel id",
"type": "string",
"minLength": 1
},
"is_shorts": {
"title": "Is shorts",
"type": "boolean",
"nullable": true
},
"title": {
"title": "Title",
"type": "string"
},
"published_at": {
"title": "Published at",
"type": "string",
"format": "date-time"
},
"duration": {
"title": "Duration",
"type": "string",
"minLength": 1
},
"views": {
"title": "Views",
"type": "integer"
},
"likes": {
"title": "Likes",
"type": "integer"
},
"dislikes": {
"title": "Dislikes",
"type": "integer"
},
"comments": {
"title": "Comments",
"type": "integer"
},
"genre": {
"title": "Genre",
"type": "string",
"minLength": 1
},
"thumbnail": {
"title": "Thumbnail",
"type": "string"
},
"description": {
"title": "Description",
"type": "string"
},
"keywords": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
},
"subtitles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/YouTubeSubtitles"
}
},
"comments_tabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/YouTubeCommentsTab"
}
}
},
"x-stoplight": {
"id": "i9oh61wtl0ry4"
}
},
"YouTubeVideoInfoResponse": {
"required": [
"success"
],
"type": "object",
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"video_info": {
"$ref": "#/components/schemas/YouTubeVideoInfoData"
}
},
"x-stoplight": {
"id": "2p5lk7tfac66q"
}
},
"YouTubeVideoComment": {
"required": [
"comment_id",
"author_picture",
"published_at",
"likes"
],
"type": "object",
"properties": {
"comment_id": {
"title": "Comment id",
"type": "string",
"minLength": 1
},
"author_channel_id": {
"title": "Author channel id",
"type": "string",
"minLength": 1
},
"author_name": {
"title": "Author name",
"description": "Legacy, seems to be replaced by author_display_name",
"type": "string",
"minLength": 1
},
"author_display_name": {
"title": "Author display name",
"type": "string",
"minLength": 1
},
"author_picture": {
"title": "Author picture",
"type": "string",
"format": "uri",
"minLength": 1
},
"published_at": {
"title": "Published at",
"type": "string",
"minLength": 1
},
"author_is_channel_owner": {
"title": "Author is channel owner",
"type": "boolean"
},
"likes": {
"title": "Likes",
"type": "integer"
},
"liked_by_creator": {
"title": "Liked by creator",
"type": "boolean"
},
"text": {
"title": "Text",
"type": "string",
"minLength": 1
},
"reply_count": {
"title": "Reply count",
"type": "integer"
},
"replies_cursor": {
"title": "Replies cursor",
"type": "string",
"readOnly": true
}
},
"x-stoplight": {
"id": "lxhnb3ou38ehd"
}
},
"YouTubeVideoCommentsData": {
"required": [
"comments"
],
"type": "object",
"properties": {
"comments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/YouTubeVideoComment"
}
},
"cursor": {
"title": "Cursor",
"type": "string",
"readOnly": true
}
},
"x-stoplight": {
"id": "drqg3x8pd0ot2"
}
},
"YouTubeVideoCommentsResponse": {
"required": [
"success",
"comments_list"
],
"type": "object",
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"comments_list": {
"$ref": "#/components/schemas/YouTubeVideoCommentsData"
}
},
"x-stoplight": {
"id": "q9m5t6agsu989"
}
},
"YouTubeVideoCommentReply": {
"required": [
"comment_id",
"author_picture",
"published_at",
"likes"
],
"type": "object",
"properties": {
"comment_id": {
"title": "Comment id",
"type": "string",
"minLength": 1
},
"author_channel_id": {
"title": "Author channel id",
"type": "string",
"minLength": 1
},
"author_name": {
"title": "Author name",
"description": "Legacy, seems to be replaced by author_display_name",
"type": "string",
"minLength": 1
},
"author_display_name": {
"title": "Author display name",
"type": "string",
"minLength": 1
},
"author_picture": {
"title": "Author picture",
"type": "string",
"format": "uri",
"minLength": 1
},
"published_at": {
"title": "Published at",
"type": "string",
"minLength": 1
},
"author_is_channel_owner": {
"title": "Author is channel owner",
"type": "boolean"
},
"likes": {
"title": "Likes",
"type": "integer"
},
"liked_by_creator": {
"title": "Liked by creator",
"type": "boolean"
},
"text": {
"title": "Text",
"type": "string",
"minLength": 1
}
},
"x-stoplight": {
"id": "or15nxldd0h7n"
}
},
"YouTubeVideoCommentRepliesData": {
"required": [
"comments"
],
"type": "object",
"properties": {
"comments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/YouTubeVideoCommentReply"
}
},
"cursor": {
"title": "Cursor",
"type": "string",
"readOnly": true
}
},
"x-stoplight": {
"id": "4bxycodkqdxah"
}
},
"YouTubeVideoCommentRepliesResponse": {
"required": [
"success",
"replies_list"
],
"type": "object",
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"replies_list": {
"$ref": "#/components/schemas/YouTubeVideoCommentRepliesData"
}
},
"x-stoplight": {
"id": "q7wm13ud6g4y3"
}
},
"ReportUserProfile": {
"required": [
"user_id",
"username",
"picture"
],
"type": "object",
"properties": {
"user_id": {
"title": "User id",
"type": "string",
"minLength": 1
},
"username": {
"title": "Username",
"type": "string",
"minLength": 1
},
"url": {
"title": "Url",
"type": "string",
"readOnly": true,
"minLength": 1
},
"fullname": {
"title": "Fullname",
"type": "string",
"readOnly": true,
"minLength": 1
},
"picture": {
"title": "Picture",
"type": "string",
"minLength": 1
},
"followers": {
"title": "Followers",
"type": "integer"
},
"engagements": {
"title": "Engagements",
"type": "integer"
},
"is_business": {
"title": "Is business",
"type": "boolean",
"nullable": true
}
},
"x-stoplight": {
"id": "zu1mzf94mv656"
}
},
"ReportList": {
"required": [
"user_profile"
],
"type": "object",
"properties": {
"id": {
"title": "Id",
"type": "string",
"readOnly": true,
"minLength": 1
},
"created_at": {
"title": "Created at",
"type": "string",
"format": "date-time"
},
"pdf_url": {
"title": "Pdf url",
"type": "string",
"minLength": 1
},
"is_stored": {
"title": "Is stored",
"type": "boolean"
},
"user_profile": {
"$ref": "#/components/schemas/ReportUserProfile"
}
},
"x-stoplight": {
"id": "70p0q4zayy888"
}
},
"PaginatedReportsList": {
"required": [
"results"
],
"type": "object",
"properties": {
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReportList"
}
}
},
"x-stoplight": {
"id": "2egb3piqik9vp"
}
},
"OverlapReportInfo": {
"required": [
"total_followers",
"total_unique_followers"
],
"type": "object",
"properties": {
"total_followers": {
"title": "Total followers",
"description": "Total number of followers of all influencers",
"type": "integer"
},
"total_unique_followers": {
"title": "Total unique followers",
"description": "Estimated number of unique followers over all influencers in the request. This includes both unique audience from each of the influencers as well as audience shared by multiple influencers.",
"type": "integer"
}
},
"x-stoplight": {
"id": "r6jxwex8rn0ek"
}
},
"OverlapReportItem": {
"required": [
"user_id",
"followers",
"unique_percentage",
"overlapping_percentage"
],
"type": "object",
"properties": {
"user_id": {
"title": "User id",
"type": "string",
"minLength": 1
},
"username": {
"title": "Username",
"type": "string",
"minLength": 1
},
"followers": {
"title": "Followers",
"description": "Number of followers of this influencer",
"type": "integer"
},
"unique_percentage": {
"title": "Unique percentage",
"description": "Estimated percent of unique followers of this infliuencer, i.e. they do not follow other influencers from the request",
"type": "number"
},
"overlapping_percentage": {
"title": "Overlapping percentage",
"description": "Estimated percent of followers which follows at least one other influencer from the request",
"type": "number"
}
},
"x-stoplight": {
"id": "dmk7ziina0bz3"
}
},
"OverlapReport": {
"required": [
"success",
"report_info",
"data"
],
"type": "object",
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"report_info": {
"$ref": "#/components/schemas/OverlapReportInfo"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OverlapReportItem"
}
}
},
"x-stoplight": {
"id": "it5ycyoiea9x0"
}
},
"OverlapErrorErrorsItem": {
"description": "Detailed list of errors",
"required": [
"error",
"error_message",
"account"
],
"type": "object",
"properties": {
"error": {
"title": "Error",
"description": "Error code",
"type": "string",
"minLength": 1
},
"error_message": {
"title": "Error message",
"description": "Human readable error text",
"type": "string",
"minLength": 1
},
"account": {
"title": "Account",
"description": "Username or user id",
"type": "string",
"minLength": 1
}
},
"x-stoplight": {
"id": "8kpdiujxo7dvw"
}
},
"OverlapError": {
"required": [
"success",
"error",
"error_message",
"errors"
],
"type": "object",
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"title": "Error",
"description": "Error code in case of success=false",
"type": "string",
"minLength": 1
},
"error_message": {
"title": "Error message",
"type": "string",
"minLength": 1
},
"eta": {
"title": "Eta",
"description": "Time in minutes required to update the audience",
"type": "integer"
},
"error_on_account": {
"title": "Error on account",
"description": "ID or username (whatever was in the input) of the first account that caused the error",
"type": "string",
"minLength": 1
},
"error_on_accounts": {
"description": "Lists of IDs (or usernames, whatever was in the input) of all accounts that caused the error",
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
},
"errors": {
"description": "Detailed list of errors",
"type": "array",
"items": {
"$ref": "#/components/schemas/OverlapErrorErrorsItem"
}
}
},
"x-stoplight": {
"id": "hnwjrd7qm39mq"
}
},
"SamplingRequestFilter": {
"type": "object",
"properties": {
"geo": {
"type": "array",
"items": {
"type": "integer"
}
},
"language": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
},
"gender": {
"title": "Gender",
"type": "string",
"enum": [
"MALE",
"FEMALE"
]
},
"age_group": {
"type": "array",
"items": {
"type": "string",
"enum": [
"13-17",
"18-24",
"25-34",
"35-44",
"45-64",
"65-"
]
}
},
"following_group": {
"title": "Following group",
"description": "",
"type": "string",
"enum": [
"-500",
"500-1000",
"1000-1500",
"1500-"
]
},
"brand": {
"description": "",
"type": "array",
"items": {
"type": "integer"
}
},
"interest": {
"description": "",
"type": "array",
"items": {
"type": "integer"
}
},
"is_fake": {
"title": "Is fake",
"description": "",
"type": "boolean"
}
},
"x-stoplight": {
"id": "rlndx3sux62yt"
}
},
"SamplingRequest": {
"type": "object",
"properties": {
"filter": {
"$ref": "#/components/schemas/SamplingRequestFilter"
}
},
"x-stoplight": {
"id": "6w5u0po6j47et"
}
},
"ReportInfo": {
"required": [
"report_id",
"created",
"profile_updated"
],
"type": "object",
"properties": {
"report_id": {
"title": "Report id",
"type": "string",
"minLength": 1
},
"created": {
"title": "Created",
"description": "The date and time this report has been made",
"type": "string",
"format": "date-time"
},
"profile_updated": {
"title": "Profile updated",
"description": "Last time we have updated profile info internally",
"type": "string",
"format": "date-time"
},
"profile_is_updating": {
"title": "Profile is updating",
"description": "We are updating this account's profile info right now. Try again in 5-10 minutes if you need an updated user profile (additional cost could be applied).",
"type": "boolean"
}
},
"x-stoplight": {
"id": "4evhj0tecl31x"
}
},
"MonthlyStat": {
"description": "Monthly average of influencer's performance metrics.",
"required": [
"month",
"followers",
"avg_likes"
],
"type": "object",
"properties": {
"month": {
"title": "Month",
"type": "string",
"minLength": 1
},
"followers": {
"title": "Followers",
"type": "integer"
},
"following": {
"title": "Following",
"type": "integer"
},
"avg_likes": {
"title": "Avg likes",
"type": "integer"
},
"avg_dislikes": {
"title": "Avg dislikes",
"description": "_deprecated_",
"type": "integer"
},
"avg_comments": {
"title": "Avg comments",
"type": "integer"
},
"avg_views": {
"title": "Avg views",
"description": "",
"type": "integer"
},
"avg_shares": {
"title": "Avg shares",
"description": "",
"type": "integer"
},
"avg_saves": {
"title": "Avg saves",
"description": "",
"type": "integer"
},
"total_views": {
"title": "Total views",
"description": "",
"type": "integer"
},
"total_likes": {
"title": "Total likes",
"type": "integer"
}
},
"x-stoplight": {
"id": "ewz3d65prg633"
}
},
"Tag": {
"required": [
"tag",
"weight"
],
"type": "object",
"properties": {
"tag": {
"title": "Tag",
"type": "string",
"minLength": 1
},
"weight": {
"title": "Weight",
"type": "number"
}
},
"x-stoplight": {
"id": "kifd73p4yj9lz"
}
},
"RelevantTag": {
"required": [
"tag",
"distance",
"freq",
"tag_cnt"
],
"type": "object",
"properties": {
"tag": {
"title": "Tag",
"type": "string",
"minLength": 1
},
"distance": {
"title": "Distance",
"type": "number"
},
"freq": {
"title": "Freq",
"type": "number"
},
"tag_cnt": {
"title": "Tag cnt",
"type": "integer"
}
},
"x-stoplight": {
"id": "g1o36k6kcu109"
}
},
"ScoredUser": {
"required": [
"user_id",
"picture",
"followers",
"url",
"is_verified"
],
"type": "object",
"properties": {
"user_id": {
"title": "User id",
"type": "string",
"minLength": 1
},
"username": {
"title": "Username",
"type": "string",
"minLength": 1
},
"custom_name": {
"title": "Custom name",
"description": "",
"type": "string",
"minLength": 1
},
"picture": {
"title": "Picture",
"type": "string",
"minLength": 1
},
"followers": {
"title": "Followers",
"type": "integer"
},
"fullname": {
"title": "Fullname",
"type": "string",
"minLength": 1
},
"url": {
"title": "Url",
"type": "string",
"minLength": 1
},
"geo": {
"$ref": "#/components/schemas/Geo"
},
"is_verified": {
"title": "Is verified",
"type": "boolean"
},
"engagements": {
"title": "Engagements",
"type": "integer"
},
"avg_likes": {
"title": "Avg likes",
"type": "integer"
},
"avg_comments": {
"title": "Avg comments",
"type": "integer"
},
"avg_views": {
"title": "Avg views",
"description": "",
"type": "integer"
},
"stats": {
"description": "",
"type": "array",
"items": {
"$ref": "#/components/schemas/UserBasicStats"
}
},
"score": {
"title": "Score",
"description": "A numeric metric indicating topic distance between influencers. Lower values mean higher similarity; higher values mean greater difference.",
"type": "number"
}
},
"x-stoplight": {
"id": "7r5t0juj3irpd"
}
},
"Post": {
"required": [
"user_id",
"username",
"user_picture",
"user_url",
"type",
"post_id",
"created",
"link",
"stat",
"thumbnail"
],
"type": "object",
"properties": {
"user_id": {
"title": "User id",
"type": "string",
"minLength": 1
},
"username": {
"title": "Username",
"type": "string",
"minLength": 1
},
"user_picture": {
"title": "User picture",
"type": "string",
"minLength": 1
},
"user_url": {
"title": "User url",
"type": "string",
"minLength": 1
},
"type": {
"title": "Type",
"type": "string",
"minLength": 1
},
"post_id": {
"title": "Post id",
"type": "string",
"minLength": 1
},
"created": {
"title": "Created",
"type": "string",
"format": "date-time"
},
"text": {
"title": "Text",
"type": "string",
"default": "",
"minLength": 1
},
"link": {
"title": "Link",
"type": "string",
"minLength": 1
},
"mentions": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
},
"hashtags": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
},
"stat": {
"$ref": "#/components/schemas/PostStat"
},
"sponsor": {
"$ref": "#/components/schemas/Sponsor"
},
"image": {
"title": "Image",
"type": "string",
"minLength": 1
},
"video": {
"title": "Video",
"type": "string",
"minLength": 1
},
"thumbnail": {
"title": "Thumbnail",
"type": "string",
"minLength": 1
}
},
"x-stoplight": {
"id": "8cro57pgpncyp"
}
},
"NoThumbnailPost": {
"description": "Valid thumbnails for the recent posts are only for YouTube",
"required": [
"user_id",
"username",
"user_picture",
"user_url",
"type",
"post_id",
"created",
"link",
"stat"
],
"type": "object",
"properties": {
"user_id": {
"title": "User id",
"type": "string",
"minLength": 1
},
"username": {
"title": "Username",
"type": "string",
"minLength": 1
},
"user_picture": {
"title": "User picture",
"type": "string",
"minLength": 1
},
"user_url": {
"title": "User url",
"type": "string",
"minLength": 1
},
"type": {
"title": "Type",
"type": "string",
"minLength": 1
},
"post_id": {
"title": "Post id",
"type": "string",
"minLength": 1
},
"created": {
"title": "Created",
"type": "string",
"format": "date-time"
},
"text": {
"title": "Text",
"type": "string",
"default": "",
"minLength": 1
},
"link": {
"title": "Link",
"type": "string",
"minLength": 1
},
"mentions": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
},
"hashtags": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
},
"stat": {
"$ref": "#/components/schemas/PostStat"
},
"sponsor": {
"$ref": "#/components/schemas/Sponsor"
},
"image": {
"title": "Image",
"type": "string",
"minLength": 1
},
"video": {
"title": "Video",
"type": "string",
"minLength": 1
}
},
"x-stoplight": {
"id": "sd0tcygv71tzl"
}
},
"StatsHistoryMonthlyStat": {
"description": "",
"type": "object",
"properties": {
"month": {
"title": "Month",
"description": "",
"type": "string",
"minLength": 1
},
"avg_likes": {
"title": "Avg likes",
"description": "",
"type": "integer"
},
"avg_engagements": {
"title": "Avg engagements",
"description": "",
"type": "integer"
},
"avg_views": {
"title": "Avg views",
"description": "",
"type": "integer"
},
"avg_comments": {
"title": "Avg comments",
"description": "",
"type": "integer"
},
"avg_shares": {
"title": "Avg shares",
"description": "",
"type": "integer"
},
"avg_saves": {
"title": "Avg saves",
"description": "",
"type": "integer"
}
},
"x-stoplight": {
"id": "a8lhbji9wj5cd"
}
},
"UserPostsStats": {
"description": "",
"type": "object",
"properties": {
"post_type": {
"title": "Post type",
"description": " - `all`, `reels`\n\n - `all`\n\n - `all`, `videos`, `shorts`, `streams`",
"type": "string",
"enum": [
"all",
"reels",
"videos",
"shorts",
"streams"
]
},
"engagements": {
"title": "Engagements",
"description": "",
"type": "integer"
},
"engagement_rate": {
"title": "Engagement rate",
"description": "",
"type": "number"
},
"avg_likes": {
"title": "Avg likes",
"description": "",
"type": "integer"
},
"avg_comments": {
"title": "Avg comments",
"description": "",
"type": "integer"
},
"avg_views": {
"title": "Avg views",
"description": "",
"type": "integer"
},
"avg_reels_plays": {
"title": "Avg reels plays",
"description": "",
"type": "integer"
},
"avg_shares": {
"title": "Avg shares",
"description": "",
"type": "integer"
},
"avg_saves": {
"title": "Avg saves",
"description": "",
"type": "integer"
},
"avg_posts4w": {
"title": "Avg posts4w",
"description": "",
"type": "number"
},
"stat_history": {
"description": "",
"type": "array",
"items": {
"$ref": "#/components/schemas/StatsHistoryMonthlyStat"
}
}
},
"x-stoplight": {
"id": "98lpywbwww7o3"
}
},
"UserProfileRecentPostsTypeStat": {
"description": "",
"type": "object",
"properties": {
"type": {
"title": "Type",
"type": "string",
"enum": [
"reels",
"photo",
"carousels"
]
},
"value": {
"title": "Value",
"type": "number"
}
},
"x-stoplight": {
"id": "dxusnwc8tiooh"
}
},
"UserProfile": {
"required": [
"engagement_rate",
"engagements",
"followers",
"url",
"user_id",
"type",
"is_hidden",
"is_business",
"posts_count",
"avg_comments",
"top_posts",
"recent_posts"
],
"type": "object",
"properties": {
"account_type": {
"title": "Account type",
"description": "",
"type": "integer",
"enum": [
1,
2,
3
]
},
"age_group": {
"title": "Age group",
"type": "string",
"minLength": 1
},
"avg_likes": {
"title": "Avg likes",
"type": "integer"
},
"avg_views": {
"title": "Avg views",
"description": "",
"type": "integer"
},
"brand_affinity": {
"description": "",
"type": "array",
"items": {
"$ref": "#/components/schemas/Brand"
}
},
"contacts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Contact"
}
},
"custom_name": {
"title": "Custom name",
"description": "",
"type": "string",
"minLength": 1
},
"description": {
"title": "Description",
"type": "string"
},
"engagement_rate": {
"title": "Engagement rate",
"type": "number"
},
"engagements": {
"title": "Engagements",
"type": "integer"
},
"followers": {
"title": "Followers",
"type": "integer"
},
"fullname": {
"title": "Fullname",
"type": "string",
"minLength": 1
},
"gender": {
"title": "Gender",
"type": "string",
"enum": [
"MALE",
"FEMALE"
]
},
"geo": {
"$ref": "#/components/schemas/Geo"
},
"handle": {
"title": "Handle",
"description": "",
"type": "string",
"minLength": 1
},
"interests": {
"description": "",
"type": "array",
"items": {
"$ref": "#/components/schemas/Interest"
}
},
"is_verified": {
"title": "Is verified",
"type": "boolean"
},
"language": {
"$ref": "#/components/schemas/Language"
},
"picture": {
"title": "Picture",
"type": "string",
"minLength": 1
},
"sec_uid": {
"title": "Sec uid",
"description": "",
"type": "string",
"minLength": 1
},
"url": {
"title": "Url",
"type": "string",
"minLength": 1
},
"user_id": {
"title": "User id",
"type": "string",
"minLength": 1
},
"username": {
"title": "Username",
"type": "string",
"minLength": 1
},
"type": {
"title": "Type",
"type": "string",
"enum": [
"instagram",
"tiktok",
"youtube"
]
},
"is_hidden": {
"title": "Is hidden",
"description": "Is social media account private or not",
"type": "boolean"
},
"is_business": {
"title": "Is business",
"description": "Deprecated field in favour `account_type`. It equals to account_type = 2 or 3",
"type": "boolean"
},
"is_official_artist": {
"title": "Is official artist",
"description": "",
"type": "boolean"
},
"posts_count": {
"title": "Posts count",
"type": "integer"
},
"avg_dislikes": {
"title": "Avg dislikes",
"type": "integer"
},
"avg_comments": {
"title": "Avg comments",
"type": "integer"
},
"avg_reels_plays": {
"title": "Avg reels plays",
"description": "",
"type": "integer"
},
"avg_shares": {
"title": "Avg shares",
"description": "",
"type": "integer"
},
"avg_saves": {
"title": "Avg saves",
"description": "",
"type": "integer"
},
"total_likes": {
"title": "Total likes",
"type": "integer"
},
"total_views": {
"title": "Total views",
"description": "",
"type": "integer"
},
"stat_posts": {
"title": "Stat posts",
"description": " The number of posts published within the last 90 days, excluding the most recent 2 days",
"type": "integer"
},
"hidden_like_posts": {
"title": "Hidden like posts",
"description": " The number of those posts where likes are hidden within the last 90 days, excluding the most recent 2 days",
"type": "integer"
},
"hidden_like_posts_rate": {
"title": "Hidden like posts rate",
"description": " The percentage of posts where likes are hidden within the last 90 days, excluding the most recent 2 days",
"type": "number"
},
"stat_history": {
"description": "Monthly average of influencer's performance metrics.",
"type": "array",
"items": {
"$ref": "#/components/schemas/MonthlyStat"
}
},
"paid_post_perfomance": {
"title": "Paid post perfomance",
"description": " Percentage of how sponsored posts perform compared to organic posts. To calculate this metric we use sponsored posts for the last 6 months only.",
"type": "number"
},
"top_hashtags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Tag"
}
},
"top_mentions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Tag"
}
},
"relevant_tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RelevantTag"
}
},
"similar_users": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ScoredUser"
}
},
"top_posts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Post"
}
},
"commercial_posts": {
"description": " Last 25 sponsored posts for all the time",
"type": "array",
"items": {
"$ref": "#/components/schemas/Post"
}
},
"recent_posts": {
"description": "Valid thumbnails for the recent posts are only for YouTube",
"type": "array",
"items": {
"$ref": "#/components/schemas/NoThumbnailPost"
}
},
"top_reels": {
"description": "",
"type": "array",
"items": {
"$ref": "#/components/schemas/Post"
}
},
"recent_reels": {
"description": "",
"type": "array",
"items": {
"$ref": "#/components/schemas/NoThumbnailPost"
}
},
"stats": {
"description": "",
"type": "array",
"items": {
"$ref": "#/components/schemas/UserPostsStats"
}
},
"recent_posts_type_stat": {
"description": "",
"type": "array",
"items": {
"$ref": "#/components/schemas/UserProfileRecentPostsTypeStat"
}
},
"account_category": {
"title": "Account category",
"description": "",
"type": "string",
"minLength": 1
}
},
"x-stoplight": {
"id": "1ibcbshhbv62y"
}
},
"AudienceType": {
"required": [
"code",
"weight"
],
"type": "object",
"properties": {
"code": {
"title": "Code",
"type": "string",
"enum": [
"mass_followers",
"suspicious",
"influencers",
"real"
]
},
"weight": {
"title": "Weight",
"type": "number"
}
},
"x-stoplight": {
"id": "9evziv2lmntzt"
}
},
"User": {
"description": "Top 60 notable users (having more than 1k followers)",
"required": [
"user_id",
"picture",
"followers",
"url",
"is_verified"
],
"type": "object",
"properties": {
"user_id": {
"title": "User id",
"type": "string",
"minLength": 1
},
"username": {
"title": "Username",
"type": "string",
"minLength": 1
},
"custom_name": {
"title": "Custom name",
"description": "",
"type": "string",
"minLength": 1
},
"picture": {
"title": "Picture",
"type": "string",
"minLength": 1
},
"followers": {
"title": "Followers",
"type": "integer"
},
"fullname": {
"title": "Fullname",
"type": "string",
"minLength": 1
},
"url": {
"title": "Url",
"type": "string",
"minLength": 1
},
"geo": {
"$ref": "#/components/schemas/Geo"
},
"is_verified": {
"title": "Is verified",
"type": "boolean"
},
"engagements": {
"title": "Engagements",
"type": "integer"
},
"avg_likes": {
"title": "Avg likes",
"type": "integer"
},
"avg_comments": {
"title": "Avg comments",
"type": "integer"
},
"avg_views": {
"title": "Avg views",
"description": "",
"type": "integer"
},
"stats": {
"description": "",
"type": "array",
"items": {
"$ref": "#/components/schemas/UserBasicStats"
}
}
},
"x-stoplight": {
"id": "n0chuew8wy3gg"
}
},
"AudienceAccountsCreatedAt": {
"required": [
"code",
"weight"
],
"type": "object",
"properties": {
"code": {
"title": "Code",
"description": "Date range in format `2019-Q1`, `2018-Q3`, etc",
"type": "string",
"minLength": 1
},
"weight": {
"title": "Weight",
"description": "Percentage of audience signed up their accounts at specific date range. Only values with more than 10% are shown. It is strong signal that influencer has paid bots in his followers.",
"type": "number"
}
},
"x-stoplight": {
"id": "anl9x9gbff1wf"
}
},
"AudienceReachability": {
"required": [
"code",
"weight"
],
"type": "object",
"properties": {
"code": {
"title": "Code",
"type": "string",
"enum": [
"-500",
"500-1000",
"1000-1500",
"1500-"
]
},
"weight": {
"title": "Weight",
"description": "Percentage of audience with number of followings in specific range. For example, follows no more than 500 other accounts, or more than 500 but less than 1000",
"type": "number"
}
},
"x-stoplight": {
"id": "1l2q30mw5vm50"
}
},
"AudienceDataLikers": {
"required": [
"likes_not_from_followers"
],
"type": "object",
"properties": {
"notable_users_ratio": {
"title": "Notable users ratio",
"type": "number"
},
"audience_credibility": {
"title": "Audience credibility",
"description": "Only for Instagram",
"type": "number"
},
"credibility_class": {
"title": "Credibility class",
"description": "Only in Audience Data report.",
"type": "string",
"enum": [
"bad",
"low",
"normal",
"high",
"best"
]
},
"audience_types": {
"description": "",
"type": "array",
"items": {
"$ref": "#/components/schemas/AudienceType"
}
},
"audience_genders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AudienceGender"
}
},
"audience_ages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AudienceAge"
}
},
"audience_genders_per_age": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AudienceGenderPerAge"
}
},
"audience_ethnicities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AudienceEthnicity"
}
},
"audience_languages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AudienceLanguage"
}
},
"audience_brand_affinity": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AudienceBrand"
}
},
"audience_interests": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AudienceInterest"
}
},
"audience_geo": {
"$ref": "#/components/schemas/AudienceGeo"
},
"audience_lookalikes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ScoredUser"
}
},
"notable_users": {
"description": "Top 60 notable users (having more than 1k followers)",
"type": "array",
"items": {
"$ref": "#/components/schemas/User"
}
},
"audience_accounts_created_at": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AudienceAccountsCreatedAt"
}
},
"audience_reachability": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AudienceReachability"
}
},
"likes_not_from_followers": {
"title": "Likes not from followers",
"type": "number"
}
},
"x-stoplight": {
"id": "xzjnitre72p2i"
}
},
"AudienceLikers": {
"required": [
"success"
],
"type": "object",
"properties": {
"success": {
"title": "Success",
"description": "false if there is audience report",
"type": "boolean"
},
"error": {
"title": "Error",
"description": "Code for reason of lack of report. Only if success=false",
"type": "string",
"enum": [
"empty_audience"
]
},
"error_message": {
"title": "Error message",
"description": "Details for reason of lack of report. Only if success=false",
"type": "string",
"minLength": 1
},
"data": {
"$ref": "#/components/schemas/AudienceDataLikers"
}
},
"x-stoplight": {
"id": "ynrbh9fbbny2a"
}
},
"AudienceData": {
"type": "object",
"properties": {
"notable_users_ratio": {
"title": "Notable users ratio",
"type": "number"
},
"audience_credibility": {
"title": "Audience credibility",
"description": "Only for Instagram",
"type": "number"
},
"credibility_class": {
"title": "Credibility class",
"description": "Only in Audience Data report.",
"type": "string",
"enum": [
"bad",
"low",
"normal",
"high",
"best"
]
},
"audience_types": {
"description": "",
"type": "array",
"items": {
"$ref": "#/components/schemas/AudienceType"
}
},
"audience_genders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AudienceGender"
}
},
"audience_ages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AudienceAge"
}
},
"audience_genders_per_age": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AudienceGenderPerAge"
}
},
"audience_ethnicities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AudienceEthnicity"
}
},
"audience_languages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AudienceLanguage"
}
},
"audience_brand_affinity": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AudienceBrand"
}
},
"audience_interests": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AudienceInterest"
}
},
"audience_geo": {
"$ref": "#/components/schemas/AudienceGeo"
},
"audience_lookalikes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ScoredUser"
}
},
"notable_users": {
"description": "Top 60 notable users (having more than 1k followers)",
"type": "array",
"items": {
"$ref": "#/components/schemas/User"
}
},
"audience_accounts_created_at": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AudienceAccountsCreatedAt"
}
},
"audience_reachability": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AudienceReachability"
}
}
},
"x-stoplight": {
"id": "88h1nwn0es7o1"
}
},
"AudienceFollowers": {
"required": [
"success"
],
"type": "object",
"properties": {
"success": {
"title": "Success",
"description": "false if there is audience report",
"type": "boolean"
},
"error": {
"title": "Error",
"description": "Code for reason of lack of report. Only if success=false",
"type": "string",
"enum": [
"empty_audience"
]
},
"error_message": {
"title": "Error message",
"description": "Details for reason of lack of report. Only if success=false",
"type": "string",
"minLength": 1
},
"data": {
"$ref": "#/components/schemas/AudienceData"
},
"is_hidden": {
"title": "Is hidden",
"description": "If influencer has hidden its followers list or not",
"type": "boolean"
}
},
"x-stoplight": {
"id": "4wavto89c36bh"
}
},
"AudienceCommenters": {
"description": "Only for YouTube",
"required": [
"success"
],
"type": "object",
"properties": {
"success": {
"title": "Success",
"description": "false if there is audience report",
"type": "boolean"
},
"error": {
"title": "Error",
"description": "Code for reason of lack of report. Only if success=false",
"type": "string",
"enum": [
"empty_audience"
]
},
"error_message": {
"title": "Error message",
"description": "Details for reason of lack of report. Only if success=false",
"type": "string",
"minLength": 1
},
"data": {
"$ref": "#/components/schemas/AudienceData"
}
},
"x-stoplight": {
"id": "gb0civku713gq"
}
},
"ExtraInfoAudienceDataFollowersRangeSeriazlier": {
"description": "All histograms here are built over influencers with followers within range defined in this field",
"type": "object",
"properties": {
"left_number": {
"title": "Left number",
"type": "integer"
},
"right_number": {
"title": "Right number",
"type": "integer"
}
},
"x-stoplight": {
"id": "vpf8cclz45dli"
}
},
"HistogramItem": {
"description": "Distribution of influencer over their Engagement Rate. It helps you to compare engagement rate to the influencers from the same followers group. Ranges were chosen automatically to a better view of the whole histogram.",
"required": [
"total"
],
"type": "object",
"properties": {
"min": {
"title": "Min",
"description": "Start of metric range",
"type": "number"
},
"max": {
"title": "Max",
"description": "End of metric range",
"type": "number"
},
"total": {
"title": "Total",
"description": "Estimate of total number of influencers having metric value in the range (min, max]",
"type": "integer"
},
"median": {
"title": "Median",
"description": "Is the range contains influencer having median value of the metric. Only one range must have true value",
"type": "boolean"
}
},
"x-stoplight": {
"id": "388j889q9j6oq"
}
},
"ExtraInfoAudienceDataReport": {
"required": [
"followers_range",
"engagement_rate_histogram"
],
"type": "object",
"properties": {
"followers_range": {
"$ref": "#/components/schemas/ExtraInfoAudienceDataFollowersRangeSeriazlier"
},
"engagement_rate_histogram": {
"description": "Distribution of influencer over their Engagement Rate. It helps you to compare engagement rate to the influencers from the same followers group. Ranges were chosen automatically to a better view of the whole histogram.",
"type": "array",
"items": {
"$ref": "#/components/schemas/HistogramItem"
}
},
"audience_credibility_followers_histogram": {
"description": "Distribution of influencer over their Audience Followers Credibility. It helps you to compare followers credibility to the influencers from the same followers group. Ranges were chosen automatically to a better view of the whole histogram.",
"type": "array",
"items": {
"$ref": "#/components/schemas/HistogramItem"
}
},
"audience_credibility_likers_histogram": {
"description": "Distribution of influencer over their Audience Likers Credibility. It helps you to compare likers credibility to the influencers from the same followers group. Ranges were chosen automatically to a better view of the whole histogram.",
"type": "array",
"items": {
"$ref": "#/components/schemas/HistogramItem"
}
}
},
"x-stoplight": {
"id": "vath2cl8tooyw"
}
},
"SamplingReport": {
"required": [
"success",
"version",
"report_info",
"user_profile",
"audience_likers",
"audience_followers"
],
"type": "object",
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"version": {
"title": "Version",
"type": "string",
"enum": [
"2"
]
},
"report_info": {
"$ref": "#/components/schemas/ReportInfo"
},
"user_profile": {
"$ref": "#/components/schemas/UserProfile"
},
"audience_likers": {
"$ref": "#/components/schemas/AudienceLikers"
},
"audience_followers": {
"$ref": "#/components/schemas/AudienceFollowers"
},
"audience_commenters": {
"$ref": "#/components/schemas/AudienceCommenters"
},
"extra": {
"$ref": "#/components/schemas/ExtraInfoAudienceDataReport"
}
},
"x-stoplight": {
"id": "7z0ed8qormdcw"
}
},
"ErrorReportInfo": {
"description": " Contains additional info in case of `retry_later` error",
"required": [
"created",
"eta"
],
"type": "object",
"properties": {
"created": {
"title": "Created",
"description": "The date and time this report has been requested",
"type": "string",
"format": "date-time"
},
"eta": {
"title": "Eta",
"description": "Time in minutes required to update the data",
"type": "integer"
}
},
"x-stoplight": {
"id": "cn4k5brthflf9"
}
},
"SamplingError": {
"required": [
"success",
"error"
],
"type": "object",
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"title": "Error",
"type": "string",
"enum": [
"empty_audience",
"retry_later",
"subscription_expired",
"subscription_required",
"token_is_disabled",
"no_quota_remaining",
"no_tokens_remaining",
"account_not_found",
"account_removed",
"account_data_removed"
]
},
"error_message": {
"title": "Error message",
"description": "Human readable error text",
"type": "string",
"minLength": 1
},
"report_info": {
"$ref": "#/components/schemas/ErrorReportInfo"
}
},
"x-stoplight": {
"id": "gp9z95qykzpvs"
}
},
"OverlapMatrixUser": {
"type": "object",
"properties": {
"user_id": {
"title": "User id",
"type": "string",
"minLength": 1
},
"username": {
"title": "Username",
"type": "string",
"minLength": 1
},
"picture": {
"title": "Picture",
"type": "string",
"minLength": 1
},
"followers": {
"title": "Followers",
"type": "integer"
},
"fullname": {
"title": "Fullname",
"type": "string",
"minLength": 1
},
"url": {
"title": "Url",
"type": "string",
"minLength": 1
},
"is_verified": {
"title": "Is verified",
"type": "boolean"
},
"engagements": {
"title": "Engagements",
"type": "integer"
},
"geo": {
"$ref": "#/components/schemas/Geo"
}
},
"x-stoplight": {
"id": "lj308onekkk6k"
}
},
"OverlapMatrixItem": {
"type": "object",
"properties": {
"user": {
"$ref": "#/components/schemas/OverlapMatrixUser"
},
"user_id": {
"title": "User id",
"type": "string",
"minLength": 1
},
"username": {
"title": "Username",
"type": "string",
"minLength": 1
},
"followers": {
"title": "Followers",
"type": "integer"
},
"unique_percentage": {
"title": "Unique percentage",
"type": "number"
},
"overlapping_percentage": {
"title": "Overlapping percentage",
"type": "number"
}
},
"x-stoplight": {
"id": "n3b4ylor6x32u"
}
},
"OverlapMatrixReport": {
"required": [
"success",
"report_info",
"data"
],
"type": "object",
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"report_info": {
"$ref": "#/components/schemas/OverlapReportInfo"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OverlapMatrixItem"
}
}
},
"x-stoplight": {
"id": "6o6cxd0844592"
}
},
"SearchRequest": {
"required": [
"filter",
"sort",
"paging",
"audience_source"
],
"type": "object",
"properties": {
"filter": {
"$ref": "#/components/schemas/SearchFilters"
},
"sort": {
"$ref": "#/components/schemas/SearchSortSerializer"
},
"paging": {
"$ref": "#/components/schemas/SearchPaging"
},
"audience_source": {
"title": "Audience source",
"description": "What audience to use for filters - likers, followers, commenters or any matched to the filter. By default filters by first audience report we have in this order - followers, likers, commenters. Meaning that if influencer has followers data then filter by followers only. If there are no followers data then by likers. By commenters if there are no followers and likers.",
"type": "string",
"enum": [
"any",
"likers",
"followers",
"commenters"
]
}
},
"x-stoplight": {
"id": "9axl28zt4zpha"
}
},
"SearchUserProfile": {
"required": [
"engagement_rate",
"engagements",
"followers",
"is_verified",
"picture"
],
"type": "object",
"properties": {
"account_type": {
"title": "Account type",
"description": "Instagram account types, 1 - regular, 2 - business, 3 - creator",
"type": "integer",
"enum": [
1,
2,
3
]
},
"avg_views": {
"title": "Avg views",
"type": "integer"
},
"custom_name": {
"title": "Custom name",
"description": " The part of YouTube Custom URL (e.g. `https://www.youtube.com/c/CustomName`) in case if account owner had set it up.",
"type": "string",
"minLength": 1
},
"handle": {
"title": "Handle",
"type": "string",
"minLength": 1
},
"sec_uid": {
"title": "Sec uid",
"type": "string",
"minLength": 1
},
"engagement_rate": {
"title": "Engagement rate",
"type": "number"
},
"engagements": {
"title": "Engagements",
"type": "integer"
},
"followers": {
"title": "Followers",
"type": "integer"
},
"fullname": {
"title": "Fullname",
"type": "string",
"minLength": 1
},
"is_verified": {
"title": "Is verified",
"type": "boolean"
},
"picture": {
"title": "Picture",
"type": "string",
"minLength": 1
},
"url": {
"title": "Url",
"type": "string",
"minLength": 1
},
"user_id": {
"title": "User id",
"type": "string",
"minLength": 1
},
"username": {
"title": "Username",
"type": "string",
"minLength": 1
}
},
"x-stoplight": {
"id": "1wkni3tzd6ojq"
}
},
"SearchAudienceData": {
"required": [
"audience_source",
"user_profile"
],
"type": "object",
"properties": {
"audience_source": {
"title": "Audience source",
"type": "string",
"minLength": 1
},
"user_profile": {
"$ref": "#/components/schemas/SearchUserProfile"
},
"search_result_id": {
"title": "Search result id",
"type": "string",
"minLength": 1
},
"hidden_result": {
"title": "Hidden result",
"type": "boolean"
}
},
"x-stoplight": {
"id": "a1f9tyn60upn7"
}
},
"SearchAccount": {
"required": [
"account",
"match"
],
"type": "object",
"properties": {
"account": {
"$ref": "#/components/schemas/SearchAudienceData"
},
"match": {
"$ref": "#/components/schemas/MatchAudienceData"
}
},
"x-stoplight": {
"id": "piz2vt9rqj24c"
}
},
"SearchResult": {
"required": [
"accounts",
"total"
],
"type": "object",
"properties": {
"accounts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SearchAccount"
}
},
"total": {
"title": "Total",
"type": "integer"
},
"shown_accounts": {
"description": "Returns only in case of `auto_unhide=1` paramater has passed. Contains list of unlocked user ids",
"type": "array",
"items": {
"type": "integer"
}
},
"cost": {
"title": "Cost",
"description": "Returns only in case of `auto_unhide=1` paramater has passed. Contains tokens amount charged for the unlock operation",
"type": "number"
}
},
"x-stoplight": {
"id": "eevjg6ea96gii"
}
},
"SearchResultError": {
"type": "object",
"properties": {
"error": {
"title": "Error",
"type": "string",
"minLength": 1
},
"error_message": {
"title": "Error message",
"type": "string",
"minLength": 1
},
"success": {
"title": "Success",
"type": "boolean",
"default": false
}
},
"x-stoplight": {
"id": "lws2pr2a97ck5"
}
},
"UnhideRequest": {
"required": [
"search_result_ids"
],
"type": "object",
"properties": {
"search_result_ids": {
"description": "List of search result IDs to unlock",
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
}
},
"x-stoplight": {
"id": "p9z05rblhu9jq"
}
},
"UnhideResponseAudienceData": {
"required": [
"audience_source",
"user_profile"
],
"type": "object",
"properties": {
"audience_source": {
"title": "Audience source",
"type": "string",
"minLength": 1
},
"user_profile": {
"$ref": "#/components/schemas/SearchUserProfile"
}
},
"x-stoplight": {
"id": "49rhwr4lhus48"
}
},
"UnhideResponseMatchAudienceData": {
"type": "object",
"properties": {
"audience_likers": {
"$ref": "#/components/schemas/MatchAudience"
}
},
"x-stoplight": {
"id": "6vqoo3trgoj71"
}
},
"UnhideResponseAccount": {
"required": [
"account",
"match",
"search_result_id"
],
"type": "object",
"properties": {
"account": {
"$ref": "#/components/schemas/UnhideResponseAudienceData"
},
"match": {
"$ref": "#/components/schemas/UnhideResponseMatchAudienceData"
},
"search_result_id": {
"title": "Search result id",
"type": "string",
"minLength": 1
}
},
"x-stoplight": {
"id": "h4elzbbwkimca"
}
},
"UnhideResponse": {
"required": [
"accounts",
"cost",
"tokens"
],
"type": "object",
"properties": {
"accounts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UnhideResponseAccount"
}
},
"cost": {
"title": "Cost",
"description": "How much tokens has been charged for this operation",
"type": "number"
},
"tokens": {
"title": "Tokens",
"description": "How much tokens are on the balance after this operation",
"type": "number"
}
},
"x-stoplight": {
"id": "8g1d1u7d9zcds"
}
},
"SubscriptionBlockFlags": {
"description": "Status flags related to the token balance.",
"type": "object",
"properties": {
"single_credits_will_expire": {
"title": "Single credits will expire",
"description": "Token balance will expire soon and can still be renewed.",
"type": "boolean"
},
"single_credits_expired": {
"title": "Single credits expired",
"description": "Token balance already expired but may be recoverable.",
"type": "boolean"
}
},
"x-stoplight": {
"id": "ebvk9z280ghe0"
}
},
"SubscriptionSocial": {
"description": "Breakdown of quotas per social platform or aggregated bucket.",
"required": [
"name",
"enabled"
],
"type": "object",
"properties": {
"name": {
"title": "Name",
"description": "Social network or aggregated bucket the quota belongs to.",
"type": "string",
"enum": [
"common",
"instagram",
"tiktok",
"youtube",
"douyin"
]
},
"enabled": {
"title": "Enabled",
"description": "Whether the quota/subscription is currently active for this platform.",
"type": "boolean"
},
"end": {
"title": "End",
"description": "Date when access to this platform expires (if scheduled).",
"type": "string",
"format": "date-time",
"nullable": true
},
"min_followers": {
"title": "Min followers",
"description": "Minimum followers filter configured for this platform.",
"type": "integer",
"nullable": true
},
"initial_data": {
"title": "Initial data",
"description": "Initial allowance or quota applicable when the plan started.",
"type": "integer",
"nullable": true
},
"total": {
"title": "Total",
"description": "Total quota available for the platform in the current period.",
"type": "number",
"nullable": true
},
"spent": {
"title": "Spent",
"description": "Amount of quota already consumed on the platform.",
"type": "number",
"nullable": true
},
"remaining": {
"title": "Remaining",
"description": "Quota still available on the platform.",
"type": "number",
"nullable": true
}
},
"x-stoplight": {
"id": "x1tgohueezwol"
}
},
"SubscriptionBlock": {
"description": "Collection of subscription blocks describing balance, quotas, and features",
"required": [
"name",
"enabled"
],
"type": "object",
"properties": {
"name": {
"title": "Name",
"description": "Identifies the subscription block represented in the dashboard.",
"type": "string",
"enum": [
"my_tokens",
"on_demand",
"monthly_tokens",
"influencer_identific",
"audience_data",
"custom"
]
},
"enabled": {
"title": "Enabled",
"description": "Whether the subscription block is currently active.",
"type": "boolean"
},
"count": {
"title": "Count",
"description": "Current balance for single credits (tokens).",
"type": "number",
"nullable": true
},
"is_can_be_recovered": {
"title": "Is can be recovered",
"description": "Indicates whether expired tokens can still be recovered.",
"type": "boolean",
"nullable": true
},
"tokens_will_be_add": {
"title": "Tokens will be add",
"description": "Tokens that will be restored when a recovery is processed.",
"type": "number",
"nullable": true
},
"till": {
"title": "Till",
"description": "Expiration timestamp for the current balance or entitlement.",
"type": "string",
"format": "date-time",
"nullable": true
},
"paid_at": {
"title": "Paid at",
"description": "Timestamp when recovered tokens will be paid back to the balance.",
"type": "string",
"format": "date-time",
"nullable": true
},
"flags": {
"$ref": "#/components/schemas/SubscriptionBlockFlags"
},
"tokens_count": {
"title": "Tokens count",
"description": "Configured number of tokens available each billing cycle.",
"type": "number",
"nullable": true
},
"is_monthly": {
"title": "Is monthly",
"description": "True if the plan renews automatically every month.",
"type": "boolean",
"nullable": true
},
"months_has_been_paid": {
"title": "Months has been paid",
"description": "Number of monthly payments already completed.",
"type": "integer",
"nullable": true
},
"next_charge": {
"title": "Next charge",
"description": "Next scheduled billing date for this block.",
"type": "string",
"format": "date-time",
"nullable": true
},
"price": {
"title": "Price",
"description": "Price (in USD) that will be charged on the next billing date.",
"type": "number",
"nullable": true
},
"paid_periods": {
"title": "Paid periods",
"description": "Number of billing periods already paid under the contract.",
"type": "integer",
"nullable": true
},
"target_periods": {
"title": "Target periods",
"description": "Total billing periods required by the contract (if limited).",
"type": "integer",
"nullable": true
},
"tokens_spent": {
"title": "Tokens spent",
"description": "Tokens spent in excess of the prepaid balance for on-demand plans.",
"type": "number",
"nullable": true
},
"total": {
"title": "Total",
"description": "Quota limit associated with the block (monthly requests, posts, etc.).",
"type": "number",
"nullable": true
},
"spent": {
"title": "Spent",
"description": "Quota already consumed within the current period.",
"type": "number",
"nullable": true
},
"remaining": {
"title": "Remaining",
"description": "Quota remaining before overusage charges apply.",
"type": "number",
"nullable": true
},
"overusage": {
"title": "Overusage",
"description": "Usage above the quota (if tracked for the block).",
"type": "number",
"nullable": true
},
"is_can_be_exceeded": {
"title": "Is can be exceeded",
"description": "Indicates whether the user can exceed the quota and pay for overusage.",
"type": "boolean",
"nullable": true
},
"social": {
"description": "Breakdown of quotas per social platform or aggregated bucket.",
"type": "array",
"items": {
"$ref": "#/components/schemas/SubscriptionSocial"
}
},
"end": {
"title": "End",
"description": "Date when the subscription or feature ends (if scheduled).",
"type": "string",
"format": "date-time",
"nullable": true
},
"title": {
"title": "Title",
"description": "Title of the custom subscription plan (if applicable).",
"type": "string",
"nullable": true
},
"description": {
"title": "Description",
"description": "Description of the custom subscription plan.",
"type": "string",
"nullable": true
}
},
"x-stoplight": {
"id": "rs0m8n0kp8j8c"
}
},
"SubscriptionDashboardResponse": {
"required": [
"result"
],
"type": "object",
"properties": {
"result": {
"description": "Collection of subscription blocks describing balance, quotas, and features",
"type": "array",
"items": {
"$ref": "#/components/schemas/SubscriptionBlock"
}
}
},
"x-stoplight": {
"id": "ww5bnie9fuv45"
}
}
}
},
"security": [
{
"header": []
}
]
}