{ "openapi": "3.1.0", "info": { "title": "Synthesio API", "version": "1.0.0" }, "servers": [ { "url": "https://api.synthesio.com/v1" } ], "paths": { "/projects/{project_id}/mentions/_search": { "post": { "tags": [ "Mentions" ], "summary": "Search", "description": "Searches for mentions in the project.", "operationId": "search_projects__project_id__mentions__search_post", "security": [ { "OAuth2PasswordBearer": [ "read", "readextended", "sia", "godpower", "internal" ] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "ID of the project", "title": "Project Id" }, "description": "ID of the project" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MentionsSearchReq" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MentionsSearchResp" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResp" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResp" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResp" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResp" } } } }, "405": { "description": "Method not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResp" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResp" } } } } } } }, "/projects/{project_id}/mentions/_analyze": { "post": { "tags": [ "Mentions" ], "summary": "Analyze", "description": "Run statistical analysis on mentions in the project.\n\nSee the *Analytics guide* for more details on how to use this endpoint.", "operationId": "analyze_projects__project_id__mentions__analyze_post", "security": [ { "OAuth2PasswordBearer": [ "read", "readextended", "sia", "godpower", "internal", "analytics" ] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "ID of the project", "title": "Project Id" }, "description": "ID of the project" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MentionsAnalyzeReq" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MentionsAnalyzeResp" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResp" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResp" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResp" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResp" } } } }, "405": { "description": "Method not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResp" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResp" } } } } } } }, "/projects": { "get": { "tags": [ "Projects" ], "summary": "List Projects", "description": "Lists the projects accessible by the user.", "operationId": "list_projects_projects_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListProjectsResp" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResp" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResp" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResp" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResp" } } } }, "405": { "description": "Method not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResp" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResp" } } } } }, "security": [ { "OAuth2PasswordBearer": [ "read", "readextended", "sia", "godpower", "internal" ] } ] } }, "/projects/{project_id}/setup/social/topics": { "get": { "tags": [ "Setup" ], "summary": "List Topics", "description": "Lists the topics in the social setup of the project.", "operationId": "list_topics_projects__project_id__setup_social_topics_get", "security": [ { "OAuth2PasswordBearer": [ "read", "readextended", "sia", "godpower", "internal" ] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "ID of the project", "title": "Project Id" }, "description": "ID of the project" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListTopicsResp" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResp" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResp" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResp" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResp" } } } }, "405": { "description": "Method not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResp" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResp" } } } } } } }, "/projects/{project_id}/setup/classifiers": { "get": { "tags": [ "Setup" ], "summary": "List Classifiers", "description": "Lists the classifiers and classifier tags in the setup of the project.", "operationId": "list_classifiers_projects__project_id__setup_classifiers_get", "security": [ { "OAuth2PasswordBearer": [ "read", "readextended", "sia", "godpower", "internal" ] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "ID of the project", "title": "Project Id" }, "description": "ID of the project" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListClassifiersResp" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResp" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResp" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResp" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResp" } } } }, "405": { "description": "Method not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResp" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResp" } } } } } } }, "/projects/{project_id}/setup/custom_metrics": { "get": { "tags": [ "Setup" ], "summary": "List Custom Metrics", "description": "Lists the custom metrics available in the project.", "operationId": "list_custom_metrics_projects__project_id__setup_custom_metrics_get", "security": [ { "OAuth2PasswordBearer": [ "read", "readextended", "sia", "godpower", "internal" ] } ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "description": "ID of the project", "title": "Project Id" }, "description": "ID of the project" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListCustomMetricsResp" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResp" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResp" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResp" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResp" } } } }, "405": { "description": "Method not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResp" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResp" } } } } } } } }, "components": { "schemas": { "Attachment": { "properties": { "thumbnail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Thumbnail", "description": "URL of the attachment's thumbnail", "examples": [ "https://example.com/p/123456789012345/attachment_thumbnail.jpg" ] }, "type": { "anyOf": [ { "type": "string", "enum": [ "image", "video" ] }, { "type": "string" } ], "title": "Type", "description": "Media type of the attachment" }, "url": { "type": "string", "title": "Url", "examples": [ "https://example.com/p/123456789012345/attachment.jpg" ] } }, "type": "object", "required": [ "type", "url" ], "title": "Attachment" }, "Author": { "properties": { "bio": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Bio", "examples": [ "I like pizza" ] }, "followers": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Followers", "description": "Number of followers/subscribers the author has", "examples": [ 1000 ] }, "id": { "type": "string", "title": "Id", "description": "Synthesio ID of the author", "examples": [ "1234-12345678" ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Full name of the author", "examples": [ "John Dough" ] }, "native_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Native Id", "description": "ID of the author, depending on the site", "examples": [ "johnny42_1234567" ] }, "profile_picture": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Picture", "description": "URL of the author's profile picture", "examples": [ "https://example.com/johnny42/pic.jpg" ] }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Url", "description": "URL of the author's profile", "examples": [ "https://example.com/johnny42" ] }, "username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Username", "examples": [ "johnny42" ] } }, "type": "object", "required": [ "id" ], "title": "Author" }, "BlueskyInteractions": { "properties": { "likes": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Likes" }, "replies": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Replies" }, "reposts": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Reposts" }, "bookmarks": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Bookmarks" }, "quotes": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Quotes" } }, "type": "object", "title": "BlueskyInteractions" }, "Classifier": { "properties": { "id": { "type": "string", "title": "Id", "examples": [ "hyed6neet3amr2nw3rr1" ] }, "name": { "type": "string", "title": "Name", "examples": [ "Pizza toppings" ] } }, "type": "object", "required": [ "id", "name" ], "title": "Classifier" }, "ClassifierDetails": { "properties": { "id": { "type": "string", "title": "Id", "examples": [ "9u3ki3tyseuh44y96cf9", "1etd8ajowh4udshebxxn" ] }, "name": { "type": "string", "title": "Name", "examples": [ "Mozzarella", "Pepperoni" ] }, "color": { "anyOf": [ { "$ref": "#/components/schemas/Color" }, { "type": "null" } ] }, "tag_ids": { "items": { "type": "string" }, "type": "array", "title": "Tag Ids", "default": [], "examples": [ [ "ujgzemcflhdy2qpbgpe5" ] ] } }, "type": "object", "required": [ "id", "name", "color" ], "title": "ClassifierDetails" }, "ClassifierTagDetails": { "properties": { "id": { "type": "string", "title": "Id", "examples": [ "ujgzemcflhdy2qpbgpe5" ] }, "color": { "anyOf": [ { "$ref": "#/components/schemas/Color" }, { "type": "null" } ] }, "name": { "type": "string", "title": "Name", "examples": [ "Pizza toppings" ] } }, "type": "object", "required": [ "id", "color", "name" ], "title": "ClassifierTagDetails" }, "Color": { "type": "string", "pattern": "^#[a-f0-9]{6}$", "description": "Hexadecimal color code in #rrggbb format", "examples": [ "#c42207", "#2abb17" ] }, "Country": { "type": "string", "maxLength": 3, "minLength": 3, "description": "An ISO 3166-1 alpha-3 country code. The reserved code `ZZZ` is used to indicate an unknown country.", "examples": [ "USA", "FRA", "ESP", "ZZZ" ] }, "CustomMetric": { "properties": { "id": { "type": "string", "title": "Id", "examples": [ "1VslmLSV1yT7kYiXcisx53KT97y", "aueYbl1UPcIHiPvFKG9kMjU0JL8" ] }, "name": { "type": "string", "title": "Name", "examples": [ "Share of positive", "Long Term Velocity" ] }, "description": { "type": "string", "title": "Description", "default": "", "examples": [ "Share of mentions with positive sentiment", "" ] } }, "type": "object", "required": [ "id", "name" ], "title": "CustomMetric" }, "DateDimension": { "properties": { "type": { "type": "string", "const": "date", "title": "Type" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Custom name for this dimension, replacing the value of the buckets' `type` in the response" }, "interval": { "type": "string", "enum": [ "day", "week", "month", "year" ], "title": "Interval", "description": "Calendar size of each bucket", "default": "week" } }, "type": "object", "required": [ "type" ], "title": "DateDimension" }, "Dimension": { "oneOf": [ { "$ref": "#/components/schemas/DateDimension" }, { "$ref": "#/components/schemas/TermsDimension" }, { "$ref": "#/components/schemas/SemanticsDimension" }, { "$ref": "#/components/schemas/FiltersDimension" } ], "discriminator": { "propertyName": "type", "mapping": { "affinities": "#/components/schemas/TermsDimension", "age": "#/components/schemas/TermsDimension", "age_range": "#/components/schemas/FiltersDimension", "attachment": "#/components/schemas/TermsDimension", "author": "#/components/schemas/TermsDimension", "author_bio": "#/components/schemas/TermsDimension", "brand": "#/components/schemas/TermsDimension", "channel": "#/components/schemas/TermsDimension", "city": "#/components/schemas/TermsDimension", "country": "#/components/schemas/TermsDimension", "date": "#/components/schemas/DateDimension", "date_list": "#/components/schemas/TermsDimension", "document_kind": "#/components/schemas/TermsDimension", "emoji": "#/components/schemas/TermsDimension", "emotion": "#/components/schemas/TermsDimension", "family_status": "#/components/schemas/TermsDimension", "follower_count": "#/components/schemas/TermsDimension", "gender": "#/components/schemas/TermsDimension", "hashtag": "#/components/schemas/TermsDimension", "job": "#/components/schemas/TermsDimension", "language": "#/components/schemas/TermsDimension", "license": "#/components/schemas/TermsDimension", "marital_status": "#/components/schemas/TermsDimension", "media_type": "#/components/schemas/TermsDimension", "mention": "#/components/schemas/TermsDimension", "mention_type": "#/components/schemas/TermsDimension", "named_entity": "#/components/schemas/SemanticsDimension", "named_entity_category": "#/components/schemas/FiltersDimension", "noise_reducer": "#/components/schemas/FiltersDimension", "parent_id": "#/components/schemas/TermsDimension", "part_of_speech": "#/components/schemas/SemanticsDimension", "part_of_speech_meta_category": "#/components/schemas/FiltersDimension", "private_source": "#/components/schemas/TermsDimension", "publisher_category": "#/components/schemas/FiltersDimension", "publisher_meta_category": "#/components/schemas/FiltersDimension", "ratings": "#/components/schemas/TermsDimension", "report_product_review": "#/components/schemas/TermsDimension", "review_status": "#/components/schemas/TermsDimension", "root_id": "#/components/schemas/TermsDimension", "scene": "#/components/schemas/TermsDimension", "sentiment": "#/components/schemas/TermsDimension", "site": "#/components/schemas/TermsDimension", "social_vs_mainstream": "#/components/schemas/FiltersDimension", "source": "#/components/schemas/TermsDimension", "state": "#/components/schemas/TermsDimension", "token": "#/components/schemas/TermsDimension", "twitter_type": "#/components/schemas/TermsDimension", "type": "#/components/schemas/TermsDimension", "url": "#/components/schemas/TermsDimension", "weekday": "#/components/schemas/TermsDimension" } } }, "DouyinInteractions": { "properties": { "favorites": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Favorites" }, "likes": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Likes" }, "reviews": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Reviews" }, "reposts": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Reposts" }, "views": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Views" } }, "type": "object", "title": "DouyinInteractions" }, "Emotion": { "anyOf": [ { "type": "string", "enum": [ "joy", "sadness", "anger", "fear", "surprise", "disgust", "neutral", "unassigned" ] }, { "type": "string" } ] }, "ErrorInfo": { "properties": { "code": { "type": "string", "title": "Code", "description": "Error code identifying the type of error" }, "detail": { "type": "string", "title": "Detail", "description": "Message describing the problem" }, "request_id": { "type": "string", "title": "Request Id", "description": "Unique identifier for the request" }, "meta": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Meta", "description": "Additional metadata about the error" } }, "type": "object", "required": [ "code", "detail", "request_id" ], "title": "ErrorInfo" }, "ErrorResp": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/ErrorInfo" }, "type": "array", "title": "Errors", "description": "Error that caused the request to fail; even though this is a list, it usually contains a single error" } }, "type": "object", "required": [ "errors" ], "title": "ErrorResp" }, "FacebookInteractions": { "properties": { "angry_reactions": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Angry Reactions" }, "clicks": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Clicks" }, "comments": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Comments" }, "haha_reactions": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Haha Reactions" }, "likes": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Likes" }, "love_reactions": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Love Reactions" }, "reach": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Reach" }, "sad_reactions": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Sad Reactions" }, "shares": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Shares" }, "views": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Views" }, "wow_reactions": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Wow Reactions" } }, "type": "object", "title": "FacebookInteractions" }, "Filter": { "properties": { "values": { "title": "Values", "description": "The value(s) to match" }, "operator": { "type": "string", "enum": [ "must", "should", "must_not" ], "title": "Operator", "description": "The role of the filter in the filter set", "default": "must" }, "strict": { "type": "boolean", "title": "Strict", "description": "If strict, the mention must match all the filter's values", "default": false } }, "type": "object", "required": [ "values" ], "title": "Filter" }, "Filters": { "additionalProperties": { "$ref": "#/components/schemas/Filter" }, "type": "object", "title": "Filters", "description": "Filters allow selecting documents based on various criteria. A `document_kind` filter is automatically added (unless it is explicitly set) to select `\"clipping\"` documents only (i.e. social posts, news, etc.) and exclude other document kinds (search data...)\n\nSee the dedicated *Filtering guide* for more details on how to use filters, and the *Filters operator reference* for a full list of available filters. ", "examples": [ { "date": { "values": { "gte": "2025-01-01T00:00:00Z" } }, "language": { "values": [ "eng", "fra" ] }, "sentiment": { "operator": "must_not", "values": [ "negative" ] }, "synql": { "values": "\"ice cream\" OR gelato" } } ] }, "FiltersDimension": { "properties": { "type": { "type": "string", "enum": [ "age_range", "named_entity_category", "noise_reducer", "part_of_speech_meta_category", "publisher_category", "publisher_meta_category", "social_vs_mainstream" ], "title": "Type" }, "size": { "type": "integer", "title": "Size", "description": "Maximum number of buckets to return", "default": 10 }, "include": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Include", "description": "Terms to include in the dimension. No other terms will be considered. Consider setting the `size` accordingly to keep all the included buckets." }, "exclude": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Exclude", "description": "Terms to exclude from the dimension. All other terms will be considered." } }, "type": "object", "required": [ "type" ], "title": "FiltersDimension" }, "HTTPValidationError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "type": "array", "title": "Detail" } }, "type": "object", "title": "HTTPValidationError" }, "InstagramInteractions": { "properties": { "comments": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Comments" }, "likes": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Likes" }, "reach": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Reach" }, "saved": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Saved" }, "shares": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Shares" }, "views": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Views" } }, "type": "object", "title": "InstagramInteractions" }, "Interactions": { "properties": { "bluesky": { "anyOf": [ { "$ref": "#/components/schemas/BlueskyInteractions" }, { "type": "null" } ] }, "douyin": { "anyOf": [ { "$ref": "#/components/schemas/DouyinInteractions" }, { "type": "null" } ] }, "facebook": { "anyOf": [ { "$ref": "#/components/schemas/FacebookInteractions" }, { "type": "null" } ] }, "instagram": { "anyOf": [ { "$ref": "#/components/schemas/InstagramInteractions" }, { "type": "null" } ] }, "linkedin": { "anyOf": [ { "$ref": "#/components/schemas/LinkedInInteractions" }, { "type": "null" } ] }, "mainstream": { "anyOf": [ { "$ref": "#/components/schemas/MainstreamInteractions" }, { "type": "null" } ] }, "pinterest": { "anyOf": [ { "$ref": "#/components/schemas/PinterestInteractions" }, { "type": "null" } ] }, "reddit": { "anyOf": [ { "$ref": "#/components/schemas/RedditInteractions" }, { "type": "null" } ] }, "redbook": { "anyOf": [ { "$ref": "#/components/schemas/RedBookInteractions" }, { "type": "null" } ] }, "threads": { "anyOf": [ { "$ref": "#/components/schemas/ThreadsInteractions" }, { "type": "null" } ] }, "tiktok": { "anyOf": [ { "$ref": "#/components/schemas/TiktokInteractions" }, { "type": "null" } ] }, "twitter": { "anyOf": [ { "$ref": "#/components/schemas/TwitterInteractions" }, { "type": "null" } ] }, "wechat": { "anyOf": [ { "$ref": "#/components/schemas/WeChatInteractions" }, { "type": "null" } ] }, "weibo": { "anyOf": [ { "$ref": "#/components/schemas/WeiboInteractions" }, { "type": "null" } ] }, "youtube": { "anyOf": [ { "$ref": "#/components/schemas/YoutubeInteractions" }, { "type": "null" } ] }, "total_active": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total Active", "description": "Total number of active interactions. Active interactions are those where the user actively engages with the content, such as likes, comments, shares, etc." }, "total_passive": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total Passive", "description": "Total number of passive interactions. Passive interactions are those where the user passively engages with the content, such as views, impressions, etc." }, "total_interactions": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total Interactions", "description": "Total number of interactions (active + passive)" }, "total_active_owned": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total Active Owned", "description": "Total number of active interactions, including those that are only available on owned posts" }, "total_passive_owned": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total Passive Owned", "description": "Total number of passive interactions, including those that are only available on owned posts" }, "total_interactions_owned": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total Interactions Owned", "description": "Total number of interactions, including those that are only available on owned posts" }, "earned_media_value": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Earned Media Value", "description": "Earned Media Value, as computed with the dashboard's formula" }, "engagement_rate": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Engagement Rate", "description": "Engagement rate" }, "engagement_rate_owned": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Engagement Rate Owned", "description": "Engagement rate, including interactions that are only available on owned posts" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At", "description": "Last update timestamp" } }, "type": "object", "title": "Interactions" }, "Language": { "type": "string", "minLength": 3, "description": "An ISO 639-3 language code, potentially suffixed with an ISO 15924 script for certain languages (currently only Chinese), e.g., `zho-Hans` and `zho-Hant` for simplified and traditional characters, respectively. The reserved code `qtz` is used to indicate an unknown language.", "examples": [ "eng", "fra", "spa", "zho-Hans", "qtz" ] }, "LinkedInInteractions": { "properties": { "comments": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Comments" }, "likes": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Likes" } }, "type": "object", "title": "LinkedInInteractions" }, "ListClassifiersResp": { "properties": { "classifiers": { "items": { "$ref": "#/components/schemas/ClassifierDetails" }, "type": "array", "title": "Classifiers" }, "classifier_tags": { "items": { "$ref": "#/components/schemas/ClassifierTagDetails" }, "type": "array", "title": "Classifier Tags", "x-synthesio-example-count": 1 } }, "type": "object", "required": [ "classifiers", "classifier_tags" ], "title": "ListClassifiersResp" }, "ListCustomMetricsResp": { "properties": { "custom_metrics": { "items": { "$ref": "#/components/schemas/CustomMetric" }, "type": "array", "title": "Custom Metrics" } }, "type": "object", "required": [ "custom_metrics" ], "title": "ListCustomMetricsResp" }, "ListProjectsResp": { "properties": { "projects": { "items": { "$ref": "#/components/schemas/Project" }, "type": "array", "title": "Projects", "description": "List of projects accessible by the user", "examples": [ [ { "id": "123456", "name": "Brand Health" }, { "id": "654321", "name": "Campaign Performance" } ] ] } }, "type": "object", "required": [ "projects" ], "title": "ListProjectsResp" }, "ListTopicsResp": { "properties": { "topics": { "items": { "$ref": "#/components/schemas/TopicDetails" }, "type": "array", "title": "Topics", "description": "List of topics in the social setup of the project. In case of two-level topic setup, these are the top-level topics." } }, "type": "object", "required": [ "topics" ], "title": "ListTopicsResp" }, "Location": { "properties": { "country": { "anyOf": [ { "$ref": "#/components/schemas/Country" }, { "type": "null" } ] } }, "type": "object", "title": "Location" }, "MainstreamInteractions": { "properties": { "facebook_shares": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Facebook Shares" }, "linked_in_shares": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Linked In Shares" }, "pinterest_shares": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Pinterest Shares" } }, "type": "object", "title": "MainstreamInteractions" }, "Mention": { "properties": { "attachments": { "items": { "$ref": "#/components/schemas/Attachment" }, "type": "array", "title": "Attachments", "description": "List of media associated with the mention", "default": [] }, "author": { "anyOf": [ { "$ref": "#/components/schemas/Author" }, { "type": "null" } ] }, "classifiers": { "items": { "$ref": "#/components/schemas/Classifier" }, "type": "array", "title": "Classifiers", "default": [] }, "classifier_tags": { "items": { "$ref": "#/components/schemas/Classifier" }, "type": "array", "title": "Classifier Tags", "default": [] }, "content": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Content", "description": "Content of the mention; for short mentions this can be empty, the full text being in the title", "examples": [ null ] }, "copyright": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Copyright", "description": "Copyright information (only present for some licensed mentions)" }, "date": { "type": "string", "format": "date-time", "title": "Date", "description": "Publication date" }, "emotion": { "$ref": "#/components/schemas/Emotion" }, "hashtags": { "items": { "type": "string" }, "type": "array", "title": "Hashtags", "description": "List of hashtags in the mention's text, without #", "default": [], "examples": [ [ "pizza", "pepperoni" ] ] }, "id": { "type": "string", "title": "Id", "description": "Synthesio ID of the mention", "examples": [ "123456789012345" ] }, "influence": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Influence", "description": "Influence score of the mention", "examples": [ 123 ] }, "infused_at": { "type": "string", "format": "date-time", "title": "Infused At", "description": "Date when the mention was first added to the project" }, "interactions": { "anyOf": [ { "$ref": "#/components/schemas/Interactions" }, { "type": "null" } ], "description": "Interactions counts (likes, views...)", "examples": [ { "total_active": 42, "total_interactions": 1042, "total_passive": 1000, "updated_at": "2024-01-01T00:00:00Z" } ] }, "language": { "anyOf": [ { "$ref": "#/components/schemas/Language" }, { "type": "null" } ] }, "license": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "License", "description": "License information (only present for licensed mentions)" }, "location": { "anyOf": [ { "$ref": "#/components/schemas/Location" }, { "type": "null" } ] }, "native_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Native Id", "description": "Unique identifier from the originating platform", "examples": [ "123456789012345" ] }, "search_data": { "anyOf": [ { "$ref": "#/components/schemas/SearchData" }, { "type": "null" } ] }, "sentiment": { "$ref": "#/components/schemas/Sentiment" }, "site": { "$ref": "#/components/schemas/Site" }, "threading": { "anyOf": [ { "$ref": "#/components/schemas/Threading" }, { "type": "null" } ], "description": "Threading information, only set for 'comment' mentions. A 'post' is never the child of another post, so its threading is always None and does not indicate whether other mentions reply to it. A 'comment' with threading set to None means its parent or root post could not be resolved." }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title", "description": "Title of the mention; for short mentions this can be the integrality of the text", "examples": [ "Pepperoni pizza is the best!" ] }, "topics": { "items": { "$ref": "#/components/schemas/Topic" }, "type": "array", "title": "Topics", "default": [] }, "type": { "anyOf": [ { "$ref": "#/components/schemas/PostType" }, { "type": "null" } ] }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Url", "examples": [ "https://example.com/p/123456789012345" ] } }, "type": "object", "required": [ "date", "emotion", "id", "infused_at", "sentiment", "site" ], "title": "Mention" }, "MentionsAnalyzeBucket": { "properties": { "id": { "type": "string", "title": "Id", "description": "Key value of the bucket", "examples": [ "positive", "neutral" ] }, "type": { "type": "string", "title": "Type", "description": "Type (or custom name) of the dimension", "examples": [ "sentiment" ] }, "values": { "additionalProperties": { "anyOf": [ { "type": "integer" }, { "type": "number" } ] }, "type": "object", "title": "Values", "description": "Metric values for this bucket", "examples": [ { "volume": 100 }, { "volume": 23 } ] }, "buckets": { "items": { "$ref": "#/components/schemas/MentionsAnalyzeBucket" }, "type": "array", "title": "Buckets", "description": "Sub-buckets for the next dimension level", "examples": [ [] ] } }, "type": "object", "required": [ "id", "type", "values", "buckets" ], "title": "MentionsAnalyzeBucket" }, "MentionsAnalyzeReq": { "properties": { "filters": { "$ref": "#/components/schemas/Filters" }, "dimensions": { "items": { "$ref": "#/components/schemas/Dimension" }, "type": "array", "title": "Dimensions", "description": "List of dimensions to group mentions by. See the *Dimensions operator reference* for the full list of available dimensions.", "examples": [ [ { "type": "sentiment" } ] ] }, "metrics": { "items": { "$ref": "#/components/schemas/Metric" }, "type": "array", "minItems": 1, "title": "Metrics", "description": "List of metrics to compute for each bucket of mentions. See the *Metrics operator reference* for the full list of available metrics.", "examples": [ [ { "type": "volume" } ] ] } }, "type": "object", "required": [ "filters", "dimensions", "metrics" ], "title": "MentionsAnalyzeReq" }, "MentionsAnalyzeResp": { "properties": { "result": { "$ref": "#/components/schemas/MentionsAnalyzeResult", "description": "Result of the analytics request" } }, "type": "object", "required": [ "result" ], "title": "MentionsAnalyzeResp" }, "MentionsAnalyzeResult": { "properties": { "values": { "additionalProperties": { "anyOf": [ { "type": "integer" }, { "type": "number" } ] }, "type": "object", "title": "Values", "description": "Metric values for the whole set of mentions matching the filters", "examples": [ { "volume": 123 } ] }, "buckets": { "items": { "$ref": "#/components/schemas/MentionsAnalyzeBucket" }, "type": "array", "title": "Buckets", "description": "Buckets for the first dimension" } }, "type": "object", "required": [ "values", "buckets" ], "title": "MentionsAnalyzeResult" }, "MentionsSearchReq": { "properties": { "size": { "type": "integer", "maximum": 1000.0, "minimum": 0.0, "title": "Size", "description": "Count of results to return", "default": 10 }, "filters": { "$ref": "#/components/schemas/Filters" }, "sort": { "anyOf": [ { "items": { "$ref": "#/components/schemas/SortField" }, "type": "array" }, { "type": "null" } ], "title": "Sort", "description": "List of fields to sort by. In case of a tie on the first field, the second field will be used, and so on. If unspecified, the default is to sort by descending date." }, "next": { "anyOf": [ { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, "type": "array" }, { "type": "null" } ], "title": "Next", "description": "Cursor for fetching the next page of results. See the pagination guide for more details.", "examples": [ null ] } }, "type": "object", "required": [ "filters" ], "title": "MentionsSearchReq" }, "MentionsSearchResp": { "properties": { "total": { "type": "integer", "title": "Total", "description": "Total number of mentions matching the search filters", "examples": [ 1234 ] }, "mentions": { "items": { "$ref": "#/components/schemas/Mention" }, "type": "array", "title": "Mentions", "description": "List of mentions matching the search filters", "x-synthesio-example-count": 1 }, "next": { "anyOf": [ { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, "type": "array" }, { "type": "null" } ], "title": "Next", "description": "Cursor for fetching the next page of results. See the pagination guide for more details.", "examples": [ [ 58492848568493, "1828406849305" ] ] } }, "type": "object", "required": [ "total", "mentions", "next" ], "title": "MentionsSearchResp", "description": "Search results" }, "Metric": { "properties": { "type": { "type": "string", "title": "Type", "description": "Keyword dictating which metric is computed; see the reference for the full list." }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Custom name for this metric, replacing the key in the response's `values` objects." } }, "type": "object", "required": [ "type" ], "title": "Metric" }, "PinterestInteractions": { "properties": { "comments": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Comments" }, "likes": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Likes" }, "repins": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Repins" } }, "type": "object", "title": "PinterestInteractions" }, "PostType": { "anyOf": [ { "type": "string", "enum": [ "post", "comment", "repost", "quoted_repost" ] }, { "type": "string" } ] }, "Project": { "properties": { "id": { "type": "string", "title": "Id", "description": "ID of the project", "examples": [ "123456" ] }, "name": { "type": "string", "title": "Name", "examples": [ "Brand Health" ] } }, "type": "object", "required": [ "id", "name" ], "title": "Project" }, "RedBookInteractions": { "properties": { "favorites": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Favorites" }, "likes": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Likes" }, "reposts": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Reposts" }, "reviews": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Reviews" } }, "type": "object", "title": "RedBookInteractions" }, "RedditInteractions": { "properties": { "score": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Score" } }, "type": "object", "title": "RedditInteractions" }, "SearchData": { "properties": { "volume": { "type": "integer", "title": "Volume", "examples": [ 1234 ] }, "platform": { "type": "string", "title": "Platform", "examples": [ "google" ] }, "search_term": { "type": "string", "title": "Search Term", "examples": [ "synthesio" ] }, "search_term_english": { "type": "string", "title": "Search Term English", "examples": [ "synthesio" ] }, "related_search": { "type": "string", "title": "Related Search", "examples": [ "synthesio" ] }, "related_search_english": { "type": "string", "title": "Related Search English", "examples": [ "synthesio" ] } }, "type": "object", "required": [ "volume", "platform", "search_term", "search_term_english", "related_search", "related_search_english" ], "title": "SearchData", "description": "Fields related to Search data, i.e. mentions representing queries made in search engines." }, "SemanticsDimension": { "properties": { "type": { "type": "string", "enum": [ "named_entity", "part_of_speech" ], "title": "Type" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Custom name for this dimension, replacing the value of the buckets' `type` in the response" }, "size": { "type": "integer", "title": "Size", "description": "Maximum number of buckets to return", "default": 10 }, "include": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Include", "description": "Terms to include in the dimension. No other terms will be considered. Consider setting the `size` accordingly to keep all the included buckets." }, "exclude": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Exclude", "description": "Terms to exclude from the dimension. All other terms will be considered." }, "min_doc_count": { "type": "integer", "title": "Min Doc Count", "description": "Minimum number of documents required for a bucket to be included", "default": 1 }, "missing": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Missing", "description": "Value to use for documents missing this dimension" }, "ignore_excluded_terms": { "type": "boolean", "title": "Ignore Excluded Terms", "description": "Automatically exclude the project's configured excluded terms", "default": false } }, "type": "object", "required": [ "type" ], "title": "SemanticsDimension" }, "Sentiment": { "type": "string", "enum": [ "positive", "negative", "neutral", "unassigned" ] }, "Site": { "properties": { "id": { "type": "string", "title": "Id", "description": "Synthesio ID of the site", "examples": [ "1650630" ] }, "name": { "type": "string", "title": "Name", "examples": [ "Instagram" ] }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Url", "examples": [ "https://www.instagram.com" ] } }, "type": "object", "required": [ "id", "name" ], "title": "Site" }, "SortField": { "properties": { "field": { "anyOf": [ { "type": "string", "enum": [ "id", "date", "infused_at", "influence", "interactions.total_active", "interactions.total_active_owned", "interactions.total_interactions", "interactions.total_interactions_owned", "interactions.total_passive", "interactions.total_passive_owned", "interactions.earned_media_value", "interactions.engagement_rate", "interactions.engagement_rate_owned" ] }, { "type": "string" } ], "title": "Field", "description": "Field to sort by" }, "order": { "type": "string", "enum": [ "asc", "desc" ], "title": "Order", "description": "Sort order, *asc*ending or *desc*ending" } }, "type": "object", "required": [ "field", "order" ], "title": "SortField" }, "SubTopicDetails": { "properties": { "id": { "type": "string", "title": "Id", "examples": [ "bchyaciv2q7so4m5ncgf" ] }, "name": { "type": "string", "title": "Name", "examples": [ "Pizza", "Lemonade" ] }, "status": { "$ref": "#/components/schemas/TopicStatus" }, "color": { "$ref": "#/components/schemas/Color" } }, "type": "object", "required": [ "id", "name", "status", "color" ], "title": "SubTopicDetails" }, "TermsDimension": { "properties": { "type": { "type": "string", "enum": [ "affinities", "age", "attachment", "author", "author_bio", "brand", "channel", "city", "country", "date_list", "document_kind", "emoji", "emotion", "family_status", "follower_count", "gender", "hashtag", "job", "language", "license", "marital_status", "media_type", "mention", "mention_type", "parent_id", "private_source", "ratings", "report_product_review", "review_status", "root_id", "scene", "sentiment", "site", "source", "state", "token", "twitter_type", "type", "url", "weekday" ], "title": "Type" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Custom name for this dimension, replacing the value of the buckets' `type` in the response" }, "size": { "type": "integer", "title": "Size", "description": "Maximum number of buckets to return", "default": 10 }, "include": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Include", "description": "Terms to include in the dimension. No other terms will be considered. Consider setting the `size` accordingly to keep all the included buckets." }, "exclude": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Exclude", "description": "Terms to exclude from the dimension. All other terms will be considered." }, "min_doc_count": { "type": "integer", "title": "Min Doc Count", "description": "Minimum number of documents required for a bucket to be included", "default": 1 }, "missing": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Missing", "description": "Value to use for documents missing this dimension" } }, "type": "object", "required": [ "type" ], "title": "TermsDimension" }, "Threading": { "properties": { "parent_native_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Parent Native Id", "description": "Provider ID of this mention's parent post, if any. None if the mention is the thread's root." }, "root_native_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Root Native Id", "description": "Provider ID of the thread's root post." } }, "type": "object", "title": "Threading", "description": "Links a mention to its parent post and the root post of the thread." }, "ThreadsInteractions": { "properties": { "views": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Views" }, "likes": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Likes" }, "replies": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Replies" }, "reposts": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Reposts" }, "quotes": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Quotes" }, "shares": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Shares" } }, "type": "object", "title": "ThreadsInteractions" }, "TiktokInteractions": { "properties": { "views": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Views" }, "comments": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Comments" }, "diggs": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Diggs" }, "shares": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Shares" }, "favorites": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Favorites" } }, "type": "object", "title": "TiktokInteractions" }, "Topic": { "properties": { "id": { "type": "string", "title": "Id", "examples": [ "7vxuwk524745sftbvpqi" ] }, "name": { "type": "string", "title": "Name", "examples": [ "Pizza" ] }, "parent_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Parent Id", "examples": [ "o0jmfxuu2jab3qwfzlhq" ] }, "parent_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Parent Name", "examples": [ "Food" ] } }, "type": "object", "required": [ "id", "name" ], "title": "Topic", "description": "A topic from the project's setup. Parent fields are only set for subtopics of 2-levels projects." }, "TopicDetails": { "properties": { "id": { "type": "string", "title": "Id", "examples": [ "m35ljq3pmyo9pnhfntng" ] }, "name": { "type": "string", "title": "Name", "examples": [ "Food", "Drinks" ] }, "status": { "$ref": "#/components/schemas/TopicStatus" }, "color": { "$ref": "#/components/schemas/Color" }, "subtopics": { "anyOf": [ { "items": { "$ref": "#/components/schemas/SubTopicDetails" }, "type": "array" }, { "type": "null" } ], "title": "Subtopics", "description": "List of subtopics under this topic", "x-synthesio-example-count": 1 } }, "type": "object", "required": [ "id", "name", "status", "color" ], "title": "TopicDetails" }, "TopicStatus": { "anyOf": [ { "type": "string", "enum": [ "draft", "applied", "to_delete" ] }, { "type": "string" } ], "description": "Status of the topic:\n- `draft`: the topic has been modified but not processed yet\n- `applied`: the topic has been processed\n- `to_delete`: the topic has been removed but the removal has not been processed yet", "examples": [ "applied" ] }, "TwitterInteractions": { "properties": { "favorites": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Favorites" }, "replies": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Replies" }, "retweets": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Retweets" }, "views": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Views" }, "bookmarks": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Bookmarks" }, "quotes": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Quotes" } }, "type": "object", "title": "TwitterInteractions" }, "ValidationError": { "properties": { "loc": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "type": "array", "title": "Location" }, "msg": { "type": "string", "title": "Message" }, "type": { "type": "string", "title": "Error Type" }, "input": { "title": "Input" }, "ctx": { "type": "object", "title": "Context" } }, "type": "object", "required": [ "loc", "msg", "type" ], "title": "ValidationError" }, "WeChatInteractions": { "properties": { "likes": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Likes" }, "like_shares": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Like Shares" }, "views": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Views" } }, "type": "object", "title": "WeChatInteractions" }, "WeiboInteractions": { "properties": { "favorites": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Favorites" }, "interactions": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Interactions" }, "likes": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Likes" }, "reposts": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Reposts" }, "reviews": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Reviews" }, "video_views": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Video Views" } }, "type": "object", "title": "WeiboInteractions" }, "YoutubeInteractions": { "properties": { "comments": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Comments" }, "dislikes": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Dislikes" }, "favorites": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Favorites" }, "likes": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Likes" }, "replies": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Replies" }, "views": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Views" } }, "type": "object", "title": "YoutubeInteractions" } }, "securitySchemes": { "OAuth2PasswordBearer": { "type": "oauth2", "flows": { "password": { "scopes": { "read": "Read access", "analytics": "Read analytics only, not mention contents", "write": "Write access", "internal": "Internal access", "readextended": "Read extended access (Internal)", "sia": "SIA access (Internal)", "godpower": "Godpower access (Internal)" }, "tokenUrl": "https://rest.synthesio.com/security/v2/oauth/token" } } } } } }