{ "components": { "responses": { "DEFAULT_ERROR": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Default error response" }, "UNPROCESSABLE_ENTITY": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" } }, "schemas": { "AIGeneratedFilters": { "properties": { "media_types": { "items": { "description": "Media Type", "example": "IMAGE", "type": "string" }, "type": "array" } }, "type": "object" }, "AdCampaignsRequest": { "properties": { "limit": { "default": 100, "description": "The maximum number of ads to return.", "maximum": 100, "minimum": 0, "type": "integer" }, "offset": { "default": 0, "description": "The offset of the first ad returned.", "minimum": 0, "type": "integer" }, "sort": { "default": null, "description": "The metric to sort the results by.", "nullable": true, "type": "string" }, "source": { "description": "Source specifies which ads platform to return ads for.", "enum": [ "META_ADS", "TIKTOK_ADS" ], "type": "string" }, "source_campaign_ids": { "default": [], "description": "Filter the results by ad campaign ID.", "items": { "type": "string" }, "type": "array" } }, "required": [ "source" ], "type": "object" }, "AdMediaResponse": { "properties": { "duration": { "description": "The media duration.", "type": "number" }, "image_url": { "description": "The media url.", "type": "string" }, "post_type": { "description": "The post type.", "type": "string" } }, "required": [ "image_url", "post_type" ], "type": "object" }, "AdResponse": { "properties": { "ad_name": { "description": "The Ad name.", "type": "string" }, "ad_status": { "description": "The status of the Ad.", "type": "string" }, "media": { "description": "Media associated with the Ad.", "items": { "$ref": "#/components/schemas/AdMediaResponse" }, "type": "array" }, "metrics": { "description": "Metrics associated with the Ad.", "type": "object" }, "source": { "enum": [ "META_ADS", "TIKTOK_ADS" ], "type": "string" }, "source_ad_account_id": { "description": "The account ID.", "type": "string" }, "source_ad_id": { "description": "The Ad ID.", "type": "string" }, "source_campaign_id": { "description": "The campaign ID.", "type": "string" } }, "required": [ "source" ], "type": "object" }, "AdsResponse": { "properties": { "data": { "items": { "$ref": "#/components/schemas/AdResponse" }, "type": "array" }, "paging": { "$ref": "#/components/schemas/PagingData" } }, "type": "object" }, "AffiliateLink": { "properties": { "account_disconnected": { "description": "True if the link belongs to the same brand but a different Bitly account", "type": "boolean" }, "bitlink_id": { "type": "string" }, "bitlink_url": { "type": "string" }, "clicks": { "nullable": true, "type": "integer" }, "created_at": { "format": "date-time", "type": "string" }, "custom_back_half": { "nullable": true, "type": "string" }, "domain": { "type": "string" }, "id": { "type": "integer" }, "link_title": { "type": "string" }, "long_url": { "type": "string" }, "target_url": { "type": "string" }, "updated_at": { "format": "date-time", "type": "string" }, "utm_parameters": { "allOf": [ { "$ref": "#/components/schemas/UtmParameters" } ], "nullable": true } }, "required": [ "bitlink_id", "bitlink_url", "created_at", "domain", "id", "link_title", "long_url", "target_url", "updated_at" ], "type": "object" }, "AiAlternativeAds": { "properties": { "created_at": { "format": "date-time", "type": "string" }, "id": { "type": "integer" }, "model": { "type": "string" }, "source_ad_id": { "type": "string" }, "url": { "type": "string" }, "vision_prediction": { "type": "number" } }, "type": "object" }, "AiAlternativeAdsDelete": { "properties": { "ai_alternative_ads_ids": { "items": { "type": "integer" }, "type": "array" } }, "required": [ "ai_alternative_ads_ids" ], "type": "object" }, "AiAlternativeMedia": { "properties": { "id": { "type": "integer" }, "parent_id": { "type": "integer" }, "url": { "type": "string" }, "vision_prediction": { "type": "number" } }, "type": "object" }, "AiAlternativeMediaDelete": { "properties": { "ai_alternative_media_ids": { "items": { "type": "integer" }, "type": "array" } }, "required": [ "ai_alternative_media_ids" ], "type": "object" }, "AutocompleteResponse": { "properties": { "avatar": { "description": "URL of avatar image", "type": "string" }, "display_name": { "description": "Competitor name", "type": "string" }, "name": { "description": "Competitor handle", "type": "string" }, "target_source": { "description": "Specified source channel for competitor", "enum": [ "instagram", "INSTAGRAM", "twitter", "TWITTER", "youtube", "YOUTUBE", "facebook", "FACEBOOK", "tiktok", "TIKTOK" ], "type": "string" }, "target_source_id": { "description": "Source id of competitor from specified target source", "type": "string" } }, "type": "object" }, "BrandMediaContentTagCreate": { "properties": { "brand_media_ids": { "description": "The brand media IDs to assign content tags.", "items": { "type": "integer" }, "minItems": 1, "type": "array" }, "content_tag_ids": { "description": "The content tags IDs to to assign to each brand media.", "items": { "type": "integer" }, "minItems": 1, "type": "array" }, "create_missing_associations": { "default": false, "description": "Create missing brand association.", "type": "boolean" } }, "required": [ "brand_media_ids", "content_tag_ids" ], "type": "object" }, "BrandMediaMeta": { "additionalProperties": true, "properties": { "can_publish_within": { "allOf": [ { "$ref": "#/components/schemas/DateTimeRange" } ], "description": "Media is only allowed to be published within this range of dates." } }, "type": "object" }, "BrandMediaWithProducts": { "properties": { "brand_id": { "type": "integer" }, "duration": {}, "hide_in_widget": {}, "image_sizes": { "allOf": [ { "$ref": "#/components/schemas/ImageSizes" } ], "description": "Contains all available image sizes." }, "media_group": { "type": "string" }, "media_id": { "type": "integer" }, "media_type": {}, "original_height": { "type": "string" }, "original_width": { "type": "string" }, "predictions": { "readOnly": true }, "products": { "items": { "allOf": [ { "$ref": "#/components/schemas/MediaProduct" } ], "description": "List of products associated with the brand media", "readOnly": true }, "type": "array" }, "source_data": { "readOnly": true }, "type": { "enum": [ "instagram_owned", "INSTAGRAM_OWNED", "instagram_ugc", "INSTAGRAM_UGC", "instagram_other", "INSTAGRAM_OTHER", "instagram_owned_igtv", "INSTAGRAM_OWNED_IGTV", "instagram_ugc_igtv", "INSTAGRAM_UGC_IGTV", "instagram_other_igtv", "INSTAGRAM_OTHER_IGTV", "instagram_story", "INSTAGRAM_STORY", "instagram_story_ugc", "INSTAGRAM_STORY_UGC", "instagram_ads", "INSTAGRAM_ADS", "uploaded", "UPLOADED", "edited", "EDITED", "ai_generated", "AI_GENERATED", "pinterest_owned", "PINTEREST_OWNED", "pinterest_story", "PINTEREST_STORY", "pinterest_ugc", "PINTEREST_UGC", "facebook_owned", "FACEBOOK_OWNED", "facebook_ads", "FACEBOOK_ADS", "facebook_post_ad", "FACEBOOK_POST_AD", "facebook_post_ad_l", "FACEBOOK_POST_AD_L", "facebook_post_ad_t", "FACEBOOK_POST_AD_T", "facebook_post_ad_tl", "FACEBOOK_POST_AD_TL", "facebook_link", "FACEBOOK_LINK", "facebook_text_link", "FACEBOOK_TEXT_LINK", "facebook_text", "FACEBOOK_TEXT", "facebook_other", "FACEBOOK_OTHER", "facebook_other_text", "FACEBOOK_OTHER_TEXT", "facebook_other_tl", "FACEBOOK_OTHER_TL", "facebook_other_link", "FACEBOOK_OTHER_LINK", "twitter_owned", "TWITTER_OWNED", "twitter_owned_link", "TWITTER_OWNED_LINK", "twitter_owned_text", "TWITTER_OWNED_TEXT", "twitter_ugc", "TWITTER_UGC", "twitter_ugc_link", "TWITTER_UGC_LINK", "twitter_ugc_text", "TWITTER_UGC_TEXT", "twitter_other", "TWITTER_OTHER", "twitter_other_link", "TWITTER_OTHER_LINK", "twitter_other_text", "TWITTER_OTHER_TEXT", "tiktok_owned", "TIKTOK_OWNED", "tiktok_ugc", "TIKTOK_UGC", "tiktok_other", "TIKTOK_OTHER", "tiktok_ad_owned", "TIKTOK_AD_OWNED", "youtube_owned", "YOUTUBE_OWNED", "youtube_ugc", "YOUTUBE_UGC", "youtube_other", "YOUTUBE_OTHER", "linkedin_owned", "LINKEDIN_OWNED", "threads_owned", "THREADS_OWNED", "snapchat_owned_story", "SNAPCHAT_OWNED_STORY", "snapchat_owned_saved_story", "SNAPCHAT_OWNED_SAVED_STORY", "snapchat_owned_spotlight", "SNAPCHAT_OWNED_SPOTLIGHT", "snapchat_owned_snap", "SNAPCHAT_OWNED_SNAP" ], "type": "string" }, "urls": {}, "video_sizes": { "allOf": [ { "$ref": "#/components/schemas/VideoSizes" } ], "description": "Contains all available video sizes." } }, "required": [ "brand_id", "media_id", "type" ], "type": "object" }, "BulkHardDeleteMediaRequest": { "properties": { "brand_media_types": { "items": { "enum": [ "instagram_owned", "INSTAGRAM_OWNED", "instagram_ugc", "INSTAGRAM_UGC", "instagram_other", "INSTAGRAM_OTHER", "instagram_owned_igtv", "INSTAGRAM_OWNED_IGTV", "instagram_ugc_igtv", "INSTAGRAM_UGC_IGTV", "instagram_other_igtv", "INSTAGRAM_OTHER_IGTV", "instagram_story", "INSTAGRAM_STORY", "instagram_story_ugc", "INSTAGRAM_STORY_UGC", "instagram_ads", "INSTAGRAM_ADS", "uploaded", "UPLOADED", "edited", "EDITED", "ai_generated", "AI_GENERATED", "pinterest_owned", "PINTEREST_OWNED", "pinterest_story", "PINTEREST_STORY", "pinterest_ugc", "PINTEREST_UGC", "facebook_owned", "FACEBOOK_OWNED", "facebook_ads", "FACEBOOK_ADS", "facebook_post_ad", "FACEBOOK_POST_AD", "facebook_post_ad_l", "FACEBOOK_POST_AD_L", "facebook_post_ad_t", "FACEBOOK_POST_AD_T", "facebook_post_ad_tl", "FACEBOOK_POST_AD_TL", "facebook_link", "FACEBOOK_LINK", "facebook_text_link", "FACEBOOK_TEXT_LINK", "facebook_text", "FACEBOOK_TEXT", "facebook_other", "FACEBOOK_OTHER", "facebook_other_text", "FACEBOOK_OTHER_TEXT", "facebook_other_tl", "FACEBOOK_OTHER_TL", "facebook_other_link", "FACEBOOK_OTHER_LINK", "twitter_owned", "TWITTER_OWNED", "twitter_owned_link", "TWITTER_OWNED_LINK", "twitter_owned_text", "TWITTER_OWNED_TEXT", "twitter_ugc", "TWITTER_UGC", "twitter_ugc_link", "TWITTER_UGC_LINK", "twitter_ugc_text", "TWITTER_UGC_TEXT", "twitter_other", "TWITTER_OTHER", "twitter_other_link", "TWITTER_OTHER_LINK", "twitter_other_text", "TWITTER_OTHER_TEXT", "tiktok_owned", "TIKTOK_OWNED", "tiktok_ugc", "TIKTOK_UGC", "tiktok_other", "TIKTOK_OTHER", "tiktok_ad_owned", "TIKTOK_AD_OWNED", "youtube_owned", "YOUTUBE_OWNED", "youtube_ugc", "YOUTUBE_UGC", "youtube_other", "YOUTUBE_OTHER", "linkedin_owned", "LINKEDIN_OWNED", "threads_owned", "THREADS_OWNED", "snapchat_owned_story", "SNAPCHAT_OWNED_STORY", "snapchat_owned_saved_story", "SNAPCHAT_OWNED_SAVED_STORY", "snapchat_owned_spotlight", "SNAPCHAT_OWNED_SPOTLIGHT", "snapchat_owned_snap", "SNAPCHAT_OWNED_SNAP", null ], "nullable": true, "type": "string" }, "minItems": 1, "type": "array" }, "data": { "items": { "$ref": "#/components/schemas/BulkHardDeleteMediaRequestItem" }, "maxItems": 250, "minItems": 1, "type": "array" }, "secret": { "type": "string" } }, "required": [ "brand_media_types", "data", "secret" ], "type": "object" }, "BulkHardDeleteMediaRequestItem": { "properties": { "brand_id": { "type": "integer" }, "media_id": { "type": "integer" } }, "required": [ "brand_id", "media_id" ], "type": "object" }, "BulkHardDeleteMediaResponse": { "properties": { "data": { "items": { "$ref": "#/components/schemas/BulkHardDeleteMediaResponseItem" }, "type": "array" } }, "required": [ "data" ], "type": "object" }, "BulkHardDeleteMediaResponseItem": { "properties": { "brand_id": { "type": "integer" }, "deleted": { "type": "boolean" }, "found": { "type": "boolean" }, "media_id": { "type": "integer" } }, "required": [ "brand_id", "deleted", "found", "media_id" ], "type": "object" }, "BulkUpdateProductsRequest": { "properties": { "archived": { "default": true, "nullable": true, "type": "boolean" }, "product_ids": { "description": "The product IDs in Dash Social.", "items": { "type": "integer" }, "type": "array" } }, "type": "object" }, "CSVTaskGenerated": { "properties": { "message": { "default": null, "description": "Message about the task generated", "nullable": true, "type": "string" }, "task_id": { "default": null, "description": "The task ID of the generated task", "nullable": true, "type": "string" } }, "type": "object" }, "Campaign": { "properties": { "ad_campaigns": { "items": { "$ref": "#/components/schemas/CampaignAdCampaign" }, "type": "array" }, "avg_emv": { "description": "Sum of EMV across supported channels divided by number of posts with EMV values ", "type": "number" }, "avg_engagement_rate": { "description": "Sum of average engagement per media across supported channels divided by number of posts with avg engagement rate values ", "type": "number" }, "avg_engagements": { "description": "Sum of engagements across supported channels divided by number of posts", "type": "number" }, "benchmark_campaigns": { "description": "A list of campaign objects to benchmark the campaign against", "readOnly": true }, "brand_id": { "type": "integer" }, "created_at": { "format": "date-time", "type": "string" }, "creator_filters": { "$ref": "#/components/schemas/CreatorFilters" }, "creator_ids": { "items": { "type": "integer" }, "type": "array" }, "earliest_media_published_date": { "format": "date-time", "type": "string" }, "end_date": { "format": "date-time", "type": "string" }, "google_analytics_selected_campaigns": { "items": { "type": "string" }, "type": "array" }, "has_relationships": { "type": "boolean" }, "has_ugc": { "type": "boolean" }, "hashtags": { "nullable": true }, "id": { "type": "integer" }, "included_ad_sources": { "nullable": true }, "included_creator_sources": { "description": "A list of creator channels", "readOnly": true }, "included_media_sources": { "items": { "type": "string" }, "type": "array" }, "latest_media_published_date": { "format": "date-time", "type": "string" }, "name": { "type": "string" }, "number_of_media": { "type": "integer" }, "show_v1_facebook_metrics": { "type": "boolean" }, "show_v1_instagram_metrics": { "type": "boolean" }, "show_v2_facebook_metrics": { "type": "boolean" }, "show_v2_instagram_metrics": { "type": "boolean" }, "start_date": { "format": "date-time", "type": "string" }, "top_media": {}, "topline_metrics": { "allOf": [ { "$ref": "#/components/schemas/TopLineMetrics" } ], "description": "Custom top line metrics and goals for the campaign" }, "total_clicks": { "description": "Sum of clicks across supported channels", "type": "integer" }, "total_creator_likes": { "description": "Sum of creator likes across supported channels", "type": "integer" }, "total_emv": { "description": "Sum of EMV across supported channels", "type": "integer" }, "total_engagements": { "description": "Sum of engagements across all channels", "type": "integer" }, "total_impressions": { "description": "Sum of impressions across supported channels", "type": "integer" }, "total_video_views": { "description": "Sum of video views across supported channels", "type": "integer" }, "ttcm_orders_campaign_code": { "maxLength": 256, "nullable": true, "type": "string" }, "ttcm_orders_invite_link": { "description": "URL for inviting creators to a TikTok campaign", "format": "url", "type": "string" }, "ttcm_spark_ads_authorization_days": { "description": "Duration in which `ttcm_orders_invite_link` is valid (in days)", "type": "integer" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "brand_id" ], "type": "object" }, "Campaign1": { "properties": { "avg_emv": { "description": "Sum of EMV across supported channels divided by number of posts with EMV values ", "type": "number" }, "avg_engagement_rate": { "description": "Sum of average engagement per media across supported channels divided by number of posts with avg engagement rate values ", "type": "number" }, "avg_engagements": { "description": "Sum of engagements across supported channels divided by number of posts", "type": "number" }, "benchmark_campaigns": { "description": "A list of campaign objects to benchmark the campaign against", "readOnly": true }, "brand_id": { "type": "integer" }, "created_at": { "format": "date-time", "type": "string" }, "creator_filters": { "$ref": "#/components/schemas/CreatorFilters" }, "creator_ids": { "items": { "type": "integer" }, "type": "array" }, "earliest_media_published_date": { "format": "date-time", "type": "string" }, "end_date": { "format": "date-time", "type": "string" }, "google_analytics_selected_campaigns": { "items": { "type": "string" }, "type": "array" }, "has_relationships": { "type": "boolean" }, "has_ugc": { "type": "boolean" }, "hashtags": { "nullable": true }, "id": { "type": "integer" }, "included_ad_sources": { "nullable": true }, "included_creator_sources": { "description": "A list of creator channels", "readOnly": true }, "included_media_sources": { "items": { "type": "string" }, "type": "array" }, "latest_media_published_date": { "format": "date-time", "type": "string" }, "name": { "type": "string" }, "number_of_media": { "type": "integer" }, "show_v1_facebook_metrics": { "type": "boolean" }, "show_v1_instagram_metrics": { "type": "boolean" }, "show_v2_facebook_metrics": { "type": "boolean" }, "show_v2_instagram_metrics": { "type": "boolean" }, "start_date": { "format": "date-time", "type": "string" }, "top_media": {}, "topline_metrics": { "allOf": [ { "$ref": "#/components/schemas/TopLineMetrics" } ], "description": "Custom top line metrics and goals for the campaign" }, "total_clicks": { "description": "Sum of clicks across supported channels", "type": "integer" }, "total_creator_likes": { "description": "Sum of creator likes across supported channels", "type": "integer" }, "total_emv": { "description": "Sum of EMV across supported channels", "type": "integer" }, "total_engagements": { "description": "Sum of engagements across all channels", "type": "integer" }, "total_impressions": { "description": "Sum of impressions across supported channels", "type": "integer" }, "total_video_views": { "description": "Sum of video views across supported channels", "type": "integer" }, "ttcm_orders_campaign_code": { "maxLength": 256, "nullable": true, "type": "string" }, "ttcm_orders_invite_link": { "description": "URL for inviting creators to a TikTok campaign", "format": "url", "type": "string" }, "ttcm_spark_ads_authorization_days": { "description": "Duration in which `ttcm_orders_invite_link` is valid (in days)", "type": "integer" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "brand_id" ], "type": "object" }, "CampaignAdCampaign": { "properties": { "source": { "enum": [ "META_ADS", "TIKTOK_ADS" ], "type": "string" }, "source_ad_account_id": { "type": "string" }, "source_campaign_id": { "type": "string" } }, "required": [ "source", "source_ad_account_id", "source_campaign_id" ], "type": "object" }, "CampaignAdCampaignResponse": { "properties": { "source": { "enum": [ "META_ADS", "TIKTOK_ADS" ], "type": "string" }, "source_ad_account_id": { "type": "string" }, "source_campaign_id": { "type": "string" }, "source_campaign_name": { "type": "string" }, "source_created_at": { "format": "date-time", "type": "string" }, "source_updated_at": { "format": "date-time", "type": "string" }, "status": { "type": "string" } }, "required": [ "source", "source_ad_account_id", "source_campaign_id" ], "type": "object" }, "CampaignAffiliateLinkData": { "properties": { "affiliate_links": { "items": { "$ref": "#/components/schemas/AffiliateLink" }, "type": "array" }, "avatar_url": { "nullable": true, "type": "string" }, "campaign_id": { "type": "integer" }, "campaign_name": { "type": "string" }, "creator_id": { "type": "integer" }, "instagram_handle": { "nullable": true, "type": "string" }, "links_summary": { "$ref": "#/components/schemas/LinksSummary" }, "tiktok_handle": { "nullable": true, "type": "string" }, "youtube_handle": { "nullable": true, "type": "string" } }, "required": [ "affiliate_links", "campaign_id", "campaign_name", "creator_id", "links_summary" ], "type": "object" }, "CampaignBenchmarksChannelsFacebookResponse": { "properties": { "avg_effectiveness_rate": { "type": "number" }, "avg_effectiveness_rate_v2": { "type": "number" }, "avg_engagement_rate": { "type": "number" }, "avg_engagement_rate_v2": { "type": "number" }, "avg_reach": { "type": "number" }, "avg_reach_v2": { "type": "number" }, "engagements": { "type": "number" }, "engagements_v2": { "type": "number" }, "impressions": { "type": "number" }, "link_clicks": { "type": "number" }, "number_of_media": { "type": "number" }, "number_of_videos": { "type": "number" }, "video_views": { "type": "number" }, "views": { "type": "number" }, "views_only_videos": { "type": "number" } }, "type": "object" }, "CampaignBenchmarksChannelsInstagramResponse": { "properties": { "avg_avg_watch_time_sec": { "type": "number" }, "avg_effectiveness_engagements_rate": { "type": "number" }, "avg_effectiveness_rate": { "type": "number" }, "avg_engagement_rate": { "type": "number" }, "avg_engagement_rate_views": { "type": "number" }, "avg_reach": { "type": "number" }, "engagements": { "type": "number" }, "impressions": { "type": "number" }, "number_of_media": { "type": "number" }, "number_of_videos": { "type": "number" }, "paid_engagements": { "type": "number" }, "paid_impressions": { "type": "number" }, "paid_video_views": { "type": "number" }, "total_engagements": { "type": "number" }, "total_impressions": { "type": "number" }, "total_video_views": { "type": "number" }, "video_views": { "type": "number" }, "views": { "type": "number" }, "views_only_videos": { "type": "number" } }, "type": "object" }, "CampaignBenchmarksChannelsInstagramStoryResponse": { "properties": { "avg_completion_rate": { "type": "number" }, "avg_completion_rate_views": { "type": "number" }, "avg_exit_rate": { "type": "number" }, "avg_exit_rate_views": { "type": "number" }, "avg_reach": { "type": "number" }, "exits": { "type": "number" }, "impressions": { "type": "number" }, "link_clicks": { "type": "number" }, "number_of_media": { "type": "number" }, "views": { "type": "number" } }, "type": "object" }, "CampaignBenchmarksChannelsLikeShopResponse": { "properties": { "link_clicks": { "type": "number" } }, "type": "object" }, "CampaignBenchmarksChannelsPinterestResponse": { "properties": { "avg_engagement_rate": { "type": "number" }, "engagements": { "type": "number" }, "impressions": { "type": "number" }, "link_clicks": { "type": "number" }, "number_of_media": { "type": "number" }, "number_of_videos": { "type": "number" }, "saves": { "type": "number" }, "video_views": { "type": "number" } }, "type": "object" }, "CampaignBenchmarksChannelsTikTokLikeShopResponse": { "properties": { "link_clicks": { "type": "number" } }, "type": "object" }, "CampaignBenchmarksChannelsTikTokResponse": { "properties": { "avg_engagement_rate": { "type": "number" }, "avg_engagement_rate_views": { "type": "number" }, "avg_reach": { "type": "number" }, "avg_retention_rate": { "type": "number" }, "engagements": { "type": "number" }, "fyp_views_percentage": { "type": "number" }, "number_of_media": { "type": "number" }, "video_views": { "type": "number" } }, "type": "object" }, "CampaignBenchmarksChannelsTwitterResponse": { "properties": { "avg_engagement_rate": { "type": "number" }, "avg_engagement_rate_organic": { "type": "number" }, "avg_engagement_rate_promoted": { "type": "number" }, "engagements": { "type": "number" }, "engagements_organic": { "type": "number" }, "engagements_promoted": { "type": "number" }, "impressions": { "type": "number" }, "impressions_organic": { "type": "number" }, "impressions_promoted": { "type": "number" }, "likes": { "type": "number" }, "likes_organic": { "type": "number" }, "likes_promoted": { "type": "number" }, "link_clicks": { "type": "number" }, "link_clicks_organic": { "type": "number" }, "link_clicks_promoted": { "type": "number" }, "number_of_media": { "type": "number" }, "number_of_videos": { "type": "number" }, "video_views": { "type": "number" }, "video_views_organic": { "type": "number" }, "video_views_promoted": { "type": "number" } }, "type": "object" }, "CampaignBenchmarksChannelsUgcResponse": { "properties": { "avg_engagement_rate": { "type": "number" }, "engagements": { "type": "number" }, "estimated_reach": { "type": "number" }, "mentions": { "type": "number" }, "number_of_media": { "type": "number" }, "people_tags": { "type": "number" } }, "type": "object" }, "CampaignBenchmarksChannelsYouTubeResponse": { "properties": { "avg_view_duration": { "type": "number" }, "dislikes": { "type": "number" }, "engagements": { "type": "number" }, "likes": { "type": "number" }, "number_of_media": { "type": "number" }, "video_views": { "type": "number" }, "watch_time": { "type": "number" } }, "type": "object" }, "CampaignBenchmarksCreatorChannelsInstagramResponse": { "properties": { "avg_emv": { "type": "number" }, "avg_emv_views": { "type": "number" }, "avg_engagement_rate": { "type": "number" }, "avg_engagements": { "type": "number" }, "comments": { "type": "number" }, "emv": { "type": "number" }, "emv_views": { "type": "number" }, "engagements": { "type": "number" }, "likes": { "type": "number" }, "total_posts": { "type": "number" } }, "type": "object" }, "CampaignBenchmarksCreatorChannelsInstagramStoryResponse": { "properties": { "avg_emv": { "type": "number" }, "avg_emv_views": { "type": "number" }, "emv": { "type": "number" }, "emv_views": { "type": "number" }, "total_posts": { "type": "number" } }, "type": "object" }, "CampaignBenchmarksCreatorChannelsTikTokResponse": { "properties": { "audience_size": { "type": "number" }, "avg_emv": { "type": "number" }, "avg_engagement_rate": { "type": "number" }, "avg_engagements": { "type": "number" }, "avg_shares": { "type": "number" }, "avg_video_views": { "type": "number" }, "comments": { "type": "number" }, "emv": { "type": "number" }, "engagements": { "type": "number" }, "likes": { "type": "number" }, "shares": { "type": "number" }, "total_posts": { "type": "number" }, "video_views": { "type": "number" } }, "type": "object" }, "CampaignBenchmarksCreatorChannelsYouTubeResponse": { "properties": { "audience_size": { "type": "number" }, "avg_comments": { "type": "number" }, "avg_emv": { "type": "number" }, "avg_engagement_rate": { "type": "number" }, "avg_engagements": { "type": "number" }, "avg_likes": { "type": "number" }, "avg_views": { "type": "number" }, "comments": { "type": "number" }, "emv": { "type": "number" }, "engagements": { "type": "number" }, "likes": { "type": "number" }, "net_new_subscribers": { "type": "number" }, "total_posts": { "type": "number" }, "views": { "type": "number" } }, "type": "object" }, "CampaignBenchmarksCreatorSummaryResponse": { "properties": { "INSTAGRAM": { "$ref": "#/components/schemas/CampaignBenchmarksCreatorChannelsInstagramResponse" }, "INSTAGRAM_STORY": { "$ref": "#/components/schemas/CampaignBenchmarksCreatorChannelsInstagramStoryResponse" }, "TIKTOK": { "$ref": "#/components/schemas/CampaignBenchmarksCreatorChannelsTikTokResponse" }, "YOUTUBE": { "$ref": "#/components/schemas/CampaignBenchmarksCreatorChannelsYouTubeResponse" } }, "type": "object" }, "CampaignBenchmarksOwnedSummaryResponse": { "properties": { "CUSTOM_METRICS": { "additionalProperties": { "type": "number" }, "type": "object" }, "FACEBOOK": { "$ref": "#/components/schemas/CampaignBenchmarksChannelsFacebookResponse" }, "INSTAGRAM": { "$ref": "#/components/schemas/CampaignBenchmarksChannelsInstagramResponse" }, "INSTAGRAM_STORY": { "$ref": "#/components/schemas/CampaignBenchmarksChannelsInstagramStoryResponse" }, "LIKESHOP": { "$ref": "#/components/schemas/CampaignBenchmarksChannelsLikeShopResponse" }, "PINTEREST": { "$ref": "#/components/schemas/CampaignBenchmarksChannelsPinterestResponse" }, "TIKTOK": { "$ref": "#/components/schemas/CampaignBenchmarksChannelsTikTokResponse" }, "TIKTOK_LIKESHOP": { "$ref": "#/components/schemas/CampaignBenchmarksChannelsTikTokLikeShopResponse" }, "TWITTER": { "$ref": "#/components/schemas/CampaignBenchmarksChannelsTwitterResponse" }, "UGC": { "$ref": "#/components/schemas/CampaignBenchmarksChannelsUgcResponse" }, "YOUTUBE": { "$ref": "#/components/schemas/CampaignBenchmarksChannelsYouTubeResponse" } }, "type": "object" }, "CampaignBenchmarksSocialAdsChannelMetaAdsResponse": { "properties": { "CLICKS": { "type": "number" }, "COST_PER_CLICK": { "type": "number" }, "COST_PER_MILE": { "type": "number" }, "IMPRESSIONS": { "type": "number" }, "LINK_CLICKS": { "type": "number" }, "TOTAL_SPENT": { "type": "number" } }, "type": "object" }, "CampaignBenchmarksSocialAdsChannelTikTokAdsResponse": { "properties": { "CLICKS": { "type": "number" }, "COST_PER_CLICK": { "type": "number" }, "COST_PER_MILE": { "type": "number" }, "ENGAGEMENTS": { "type": "number" }, "IMPRESSIONS": { "type": "number" }, "TOTAL_SPENT": { "type": "number" } }, "type": "object" }, "CampaignBenchmarksSocialAdsSummaryResponse": { "properties": { "META_ADS": { "$ref": "#/components/schemas/CampaignBenchmarksSocialAdsChannelMetaAdsResponse" }, "TIKTOK_ADS": { "$ref": "#/components/schemas/CampaignBenchmarksSocialAdsChannelTikTokAdsResponse" } }, "type": "object" }, "CampaignComparison": { "properties": { "campaign_a": { "$ref": "#/components/schemas/ComparedCampaign" }, "campaign_b": { "$ref": "#/components/schemas/ComparedCampaign" }, "created_at": { "format": "date-time", "type": "string" }, "id": { "type": "integer" } }, "type": "object" }, "CampaignComparisonCreateJsonRequest": { "properties": { "campaign_a_id": { "description": "ID of campaign A to compare", "type": "integer" }, "campaign_b_id": { "description": "ID of campaign B to compare", "type": "integer" } }, "required": [ "campaign_a_id", "campaign_b_id" ], "type": "object" }, "CampaignCreate": { "properties": { "benchmark_campaigns": { "default": null, "description": "A list of campaign ids to benchmark the campaign against", "items": { "type": "integer" }, "nullable": true, "type": "array" }, "creator_filters": { "allOf": [ { "$ref": "#/components/schemas/CreatorFilters" } ], "description": "Filters to apply on the included creators" }, "creator_ids": { "default": null, "description": "List of creator IDs to add to the campaign.", "items": { "type": "integer" }, "nullable": true, "type": "array" }, "end_date": { "default": null, "description": "A formatted datetime string in UTC.", "example": "2019-12-12", "nullable": true, "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(Z|((\\+|-)\\d{2}:\\d{2})))?$", "type": "string" }, "google_analytics_selected_campaigns": { "default": null, "description": "A list of the selected google analytics campaigns.", "items": { "type": "string" }, "nullable": true, "type": "array" }, "hashtag_ids": { "default": null, "description": "A list of hashtags added to the campaign.", "items": { "type": "integer" }, "nullable": true, "type": "array" }, "name": { "description": "Name of the campaign.", "maxLength": 64, "minLength": 1, "type": "string" }, "start_date": { "default": null, "description": "A formatted datetime string in UTC.", "example": "2019-12-01", "nullable": true, "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(Z|((\\+|-)\\d{2}:\\d{2})))?$", "type": "string" }, "topline_metrics": { "allOf": [ { "$ref": "#/components/schemas/TopLineMetrics" } ], "default": null, "description": "Custom top line metrics and goals for the campaign", "nullable": true }, "ttcm_spark_ads_authorization_days": { "description": "Duration in which `ttcm_orders_invite_link` is valid (in days)", "type": "integer" } }, "required": [ "name" ], "type": "object" }, "CampaignCreatorDeliverables": { "properties": { "campaign_id": { "description": "Campaign ID of the campaign", "type": "integer" }, "creator_id": { "description": "Creator ID of the creator added in the campaign", "type": "integer" }, "deliverable_gifted": { "description": "Shows the deliverables state as GIFTED. This is separate from the GIFTED status", "type": "boolean" }, "deliverable_instagram_feed": { "description": "Number of Instagram feed posts deliverables", "type": "integer" }, "deliverable_instagram_reels": { "description": "Number of Instagram reels posts deliverables", "type": "integer" }, "deliverable_instagram_stories": { "description": "Number of Instagram stories posts deliverables", "type": "integer" }, "deliverable_tiktok_videos": { "description": "Number of TikTok video posts deliverables", "type": "integer" }, "deliverable_youtube_shorts": { "description": "Number of YouTube shorts deliverables", "type": "integer" }, "deliverable_youtube_videos": { "description": "Number of YouTube video deliverables", "type": "integer" }, "ig_connection_status": { "description": "Instagram connection status of the creator. Avoid using; use creator-backend instead.", "enum": [ "NOT_INVITED", "INVITATION_SENT", "ACCEPTED", "LAPSED", "REVOKED" ] }, "instagram_handle": { "description": "Instagram handle of the creator", "nullable": true, "type": "string" }, "latest_post_ft_you": { "description": "Latest post ft you", "type": "string" }, "published_instagram_feed": { "description": "Number of Instagram feed posts published", "type": "integer" }, "published_instagram_reels": { "description": "Number of Instagram reels posts published", "type": "integer" }, "published_instagram_stories": { "description": "Number of Instagram stories posts published", "type": "integer" }, "published_tiktok_videos": { "description": "Number of TikTok video posts published", "type": "integer" }, "published_youtube_shorts": { "description": "Number of YouTube shorts published", "type": "integer" }, "published_youtube_videos": { "description": "Number of YouTube video posts published", "type": "integer" }, "status": { "description": "Status of the campaign deliverables", "enum": [ "NEW", "CONTACTED", "AGREEMENT_SENT", "BRIEF_SENT", "PRODUCT_SHIPPED", "IN_PROGRESS", "CREATIVE_APPROVED", "PAYMENT_SENT", "COMPLETE", "DECLINED", "PAYMENT_INITIATED", "PAID" ] }, "tiktok_handle": { "description": "Tiktok handle of the creator", "nullable": true, "type": "string" }, "total_deliverables": { "description": "Total number of deliverables", "type": "integer" }, "total_published_posts": { "description": "Total number of published posts", "type": "integer" }, "tt_connection_status": { "description": "TikTok connection status of the creator. Avoid using; use creator-backend instead.", "enum": [ "NOT_INVITED", "INVITATION_SENT", "ACCEPTED", "LAPSED", "REVOKED" ] }, "user_modified_status": { "description": "Whether the `status` field has been manually edited", "type": "boolean" }, "youtube_handle": { "description": "YouTube handle of the creator", "nullable": true, "type": "string" } }, "type": "object" }, "CampaignCreatorDeliverablesResponse": { "properties": { "data": { "items": { "$ref": "#/components/schemas/CampaignCreatorDeliverables" }, "type": "array" }, "paging": { "$ref": "#/components/schemas/PagingData" }, "stats": { "$ref": "#/components/schemas/CampaignCreatorDeliverablesStats" } }, "type": "object" }, "CampaignCreatorDeliverablesStats": { "properties": { "completion": { "description": "Completion percentage", "type": "number" }, "total_creators": { "description": "Total number of creators", "type": "integer" }, "total_deliverables": { "description": "Total number of deliverables", "type": "integer" }, "total_gifted": { "description": "Total number of gifted deliverables", "type": "integer" }, "total_posts": { "description": "Total number of posts", "type": "integer" } }, "type": "object" }, "CampaignCreatorFiltersOptions": { "properties": { "only_excluded_media": { "default": false, "description": "If set to true, only excluded posts will be returned in the query. This will override all filters.", "type": "boolean" }, "show_excluded_media": { "default": false, "description": "If set to true, excluded posts will not be filtered out of the media query", "type": "boolean" } }, "type": "object" }, "CampaignCreatorInsights": { "properties": { "creator_channels": { "description": "The channels that the insights are for.", "items": { "type": "string" }, "type": "array" }, "instagram_feed_stats": { "$ref": "#/components/schemas/CampaignCreatorInsightsInstagramFeedStats" }, "instagram_stats": { "$ref": "#/components/schemas/CampaignCreatorInsightsInstagramStats" }, "instagram_story_stats": { "$ref": "#/components/schemas/CampaignCreatorInsightsInstagramStoryStats" }, "tiktok_stats": { "$ref": "#/components/schemas/CampaignCreatorInsightsTikTokStats" }, "topline_stats": { "$ref": "#/components/schemas/CampaignCreatorInsightsToplineStats" }, "youtube_stats": { "$ref": "#/components/schemas/CampaignCreatorInsightsYouTubeStats" } }, "type": "object" }, "CampaignCreatorInsightsInstagramFeedStats": { "properties": { "avg_emv": { "description": "Avg. EMV across all Instagram feed posts", "type": "number" }, "avg_emv_views": { "description": "Avg. EMV across all Instagram feed posts (new metric calculation)", "type": "number" }, "avg_engagement_rate": { "description": "The average engagement rate across all Instagram feed posts", "type": "number" }, "avg_engagements": { "description": "The average number of engagements across all Instagram feed posts", "type": "number" }, "comments": { "description": "Total number of Instagram feed post comments", "type": "integer" }, "emv": { "description": "Total EMV across all Instagram feed posts", "type": "number" }, "emv_views": { "description": "Total EMV across all Instagram feed posts (new metric calculation)", "type": "number" }, "engagements": { "description": "Total number of Instagram feed post engagements", "type": "integer" }, "likes": { "description": "Total number of Instagram feed post likes", "type": "integer" }, "total_posts": { "description": "Total number of Instagram feed posts (images, carousels, and reels)", "type": "integer" } }, "type": "object" }, "CampaignCreatorInsightsInstagramStats": { "properties": { "audience_size": { "description": "Total number of followers across all Instagram creators", "type": "integer" }, "avg_effectiveness": { "description": "The average effectiveness across all Instagram posts", "type": "number" }, "avg_effectiveness_engagements": { "description": "The average effectiveness across all Instagram posts (new metric calculation)", "type": "number" }, "avg_emv": { "description": "Avg. EMV across all Instagram posts", "type": "number" }, "avg_emv_views": { "description": "Avg. EMV across all Instagram posts (new metric calculation)", "type": "number" }, "avg_engagement_rate": { "description": "The average engagement rate across all Instagram posts", "type": "number" }, "avg_engagements": { "description": "The average number of engagements across all Instagram posts", "type": "number" }, "avg_impressions": { "description": "Avg. impressions for all Instagram media", "type": "number" }, "avg_reach": { "description": "Avg. reach for all Instagram media", "type": "number" }, "avg_views": { "description": "Avg. views for all Instagram Posts and impressions for Instagram Stories", "type": "integer" }, "avg_views_v2": { "description": "Avg. views for all Instagram Posts and Stories", "type": "integer" }, "comments": { "description": "Total number of Instagram post comments", "type": "integer" }, "emv": { "description": "Total EMV across all Instagram posts", "type": "number" }, "emv_views": { "description": "Total EMV across all Instagram posts (new metric calculation)", "type": "number" }, "engagements": { "description": "Total number of Instagram post engagements", "type": "integer" }, "followers_gained": { "description": "Total number of followers gained across all Instagram posts", "type": "integer" }, "impressions": { "description": "Total number of impressions for all Instagram media", "type": "integer" }, "likes": { "description": "Total number of Instagram post likes", "type": "integer" }, "reel_views": { "description": "Total views (public) for Instagram Reels", "nullable": true, "type": "integer" }, "story_avg_completion_rate": { "description": "Avg. completion rate for all Instagram stories", "type": "number" }, "story_avg_completion_rate_views": { "description": "Avg. completion rate by views for all Instagram stories", "type": "number" }, "story_avg_impressions": { "description": "Avg. impressions for all Instagram stories", "type": "number" }, "story_avg_reach": { "description": "Avg. reach for all Instagram stories", "type": "number" }, "story_avg_views": { "description": "Avg. views for all Instagram stories", "type": "number" }, "total_creators": { "description": "Total number of Instagram creators", "type": "integer" }, "total_posts": { "description": "Total number of Instagram posts", "type": "integer" }, "views": { "description": "Total number of views for all Instagram Posts and impressions for Instagram Stories", "type": "integer" }, "views_v2": { "description": "Total number of views for all Instagram Posts and Stories", "type": "integer" } }, "type": "object" }, "CampaignCreatorInsightsInstagramStoryStats": { "properties": { "avg_emv": { "description": "Avg. EMV across all Instagram story posts", "type": "number" }, "avg_emv_views": { "description": "Avg. EMV across all Instagram story posts (new metric calculation)", "type": "number" }, "emv": { "description": "Total EMV across all Instagram story posts", "type": "number" }, "emv_views": { "description": "Total EMV across all Instagram story posts (new metric calculation))", "type": "number" }, "total_posts": { "description": "Total number of Instagram story posts", "type": "integer" } }, "type": "object" }, "CampaignCreatorInsightsResponse": { "properties": { "data": { "$ref": "#/components/schemas/CampaignCreatorInsights" } }, "type": "object" }, "CampaignCreatorInsightsTikTokStats": { "properties": { "audience_size": { "description": "Total number of followers across all TikTok creators", "type": "integer" }, "avg_emv": { "description": "Avg. EMV across all TikTok posts", "type": "number" }, "avg_engagement_rate": { "description": "The average engagement rate across all TikTok posts", "type": "number" }, "avg_engagements": { "description": "The average number of engagement across all TikTok posts", "type": "number" }, "avg_shares": { "description": "Avg. number of shares across all TikTok posts", "type": "number" }, "avg_video_views": { "description": "Avg. number of video views across all TikTok posts", "type": "number" }, "comments": { "description": "Total number of TikTok post comments", "type": "integer" }, "emv": { "description": "Total EMV across all TikTok posts", "type": "number" }, "engagements": { "description": "Total number of TikTok post engagements", "type": "integer" }, "likes": { "description": "Total number of TikTok post likes", "type": "integer" }, "shares": { "description": "Total number of shares across all TikTok posts", "type": "integer" }, "total_creators": { "description": "Total number of TikTok creators", "type": "integer" }, "total_posts": { "description": "Total number of TikTok posts", "type": "integer" }, "video_views": { "description": "Total number of video views across all TikTok posts", "type": "integer" } }, "type": "object" }, "CampaignCreatorInsightsToplineStats": { "properties": { "audience_size": { "description": "Total number of followers across all channels", "type": "integer" }, "avg_emv": { "description": "Avg. EMV across all channels", "type": "number" }, "avg_emv_views": { "description": "Avg. EMV across all channels (new metric calculation)", "type": "number" }, "avg_engagement_rate": { "description": "The engagement rate across all channels", "type": "number" }, "avg_engagements": { "description": "The average number of engagements across all channels", "type": "number" }, "comments": { "description": "Total number of comments across all channels", "type": "integer" }, "emv": { "description": "Total EMV across all channels", "type": "number" }, "emv_views": { "description": "Total EMV across all channels (new metric calculation)", "type": "number" }, "likes": { "description": "Total number of likes across all channels", "type": "integer" }, "total_posts": { "description": "Total number of posts across all channels", "type": "integer" } }, "type": "object" }, "CampaignCreatorInsightsYouTubeStats": { "properties": { "audience_size": { "description": "Total number of subscribers across all YouTube creators", "type": "integer" }, "avg_comments": { "description": "Avg. number of comments across all YouTube posts", "type": "number" }, "avg_emv": { "description": "Avg. EMV across all YouTube posts", "type": "number" }, "avg_engagement_rate": { "description": "The average engagement rate across all YouTube posts", "type": "number" }, "avg_engagements": { "description": "The average number of engagements across all YouTube posts", "type": "number" }, "avg_likes": { "description": "Avg. number of likes across all YouTube posts", "type": "number" }, "avg_views": { "description": "Avg. number of views across all YouTube posts", "type": "number" }, "comments": { "description": "Total number of YouTube post comments", "type": "integer" }, "emv": { "description": "Total EMV across all YouTube posts", "type": "number" }, "engagements": { "description": "Total number of YouTube post engagements", "type": "integer" }, "likes": { "description": "Total number of YouTube post likes", "type": "integer" }, "net_new_subscribers": { "description": "Total number of net new subscribers across all YouTube posts", "type": "integer" }, "total_creators": { "description": "Total number of YouTube creators", "type": "integer" }, "total_posts": { "description": "Total number of YouTube posts", "type": "integer" }, "views": { "description": "Total number of YouTube post views", "type": "integer" } }, "type": "object" }, "CampaignCreatorTTCMOrder": { "properties": { "spark_ads_authorized": { "description": "Whether spark ads are authorized", "type": "boolean" } }, "type": "object" }, "CampaignCreatorTTCMOrderResponse": { "properties": { "data": { "$ref": "#/components/schemas/TTCMOrderDetails" } }, "type": "object" }, "CampaignCreatorsUpdate": { "properties": { "creator_ids": { "description": "List of creator IDs to update", "items": { "type": "integer" }, "type": "array" }, "deliverable_gifted": { "description": "Shows the deliverables state as GIFTED. This is separate from the GIFTED status", "type": "boolean" }, "deliverable_instagram_feed": { "description": "Number of Instagram feed posts deliverables", "type": "integer" }, "deliverable_instagram_reels": { "description": "Number of Instagram reels posts deliverables", "type": "integer" }, "deliverable_instagram_stories": { "description": "Number of Instagram stories posts deliverables", "type": "integer" }, "deliverable_tiktok_videos": { "description": "Number of TikTok video posts deliverables", "type": "integer" }, "deliverable_youtube_shorts": { "description": "Number of YouTube shorts deliverables", "type": "integer" }, "deliverable_youtube_videos": { "description": "Number of YouTube video deliverables", "type": "integer" }, "status": { "description": "Status of the campaign deliverables", "enum": [ "NEW", "CONTACTED", "AGREEMENT_SENT", "BRIEF_SENT", "PRODUCT_SHIPPED", "IN_PROGRESS", "CREATIVE_APPROVED", "PAYMENT_SENT", "COMPLETE", "DECLINED", "PAYMENT_INITIATED", "PAID" ], "type": "string" } }, "required": [ "creator_ids" ], "type": "object" }, "CampaignExcludeCreatorMediaRequest": { "properties": { "media_ids": { "description": "The list of creator media IDs to exclude from the campaign", "items": { "type": "integer" }, "type": "array" } }, "required": [ "media_ids" ], "type": "object" }, "CampaignIncludeCreatorMediaRequest": { "properties": { "media_ids": { "description": "The list of creator media IDs to include in the campaign", "items": { "type": "integer" }, "type": "array" } }, "required": [ "media_ids" ], "type": "object" }, "CampaignListMediaResponse": { "properties": { "data": { "items": { "$ref": "#/components/schemas/MediaV2" }, "type": "array" }, "paging": { "$ref": "#/components/schemas/PagingData" } }, "type": "object" }, "CampaignMediaBulkUpdateJsonRequest": { "properties": { "gallery_ids": { "description": "A list of IDs indicating the gallery items to perform the action with.", "items": { "type": "integer" }, "type": "array" }, "media_ids": { "description": "A list of IDs indicating the media items to perform the action with.Selected media must belong to the specified campaign.", "items": { "type": "integer" }, "type": "array" } }, "type": "object" }, "CampaignRelationshipMediaBulkUpdateJsonRequest": { "properties": { "media_ids": { "description": "A list of comma-separated IDs indicating the media items to perform the action with.Selected media must belong to the specified campaign.", "items": { "type": "integer" }, "type": "array" } }, "type": "object" }, "CampaignRelationships": { "properties": { "data": { "items": { "$ref": "#/components/schemas/CampaignRelationshipsReturn" }, "type": "array" }, "paging": { "$ref": "#/components/schemas/PagingData" } }, "type": "object" }, "CampaignRelationshipsReturn": { "properties": { "avatar_url": { "type": "string" }, "handle": { "type": "string" }, "media_ids": { "default": [], "description": "A comma separated list of media IDs to return", "items": { "type": "integer" }, "type": "array" }, "relationship_id": { "type": "integer" }, "stats": { "type": "object" } }, "type": "object" }, "CampaignSearchRequest": { "properties": { "brand_ids": { "description": "list of brand IDs to filter campaigns by", "items": { "type": "integer" }, "minItems": 1, "type": "array" }, "limit": { "maximum": 10000, "minimum": 0, "type": "integer" }, "search": { "description": "Search term to filter campaigns by", "type": "string" } }, "required": [ "brand_ids", "search" ], "type": "object" }, "CampaignSearchResponse": { "properties": { "data": { "additionalProperties": { "items": { "$ref": "#/components/schemas/Campaign1" }, "type": "array" }, "type": "object" } }, "type": "object" }, "CampaignStatsOverviewChannelsAllChannelsResponse": { "properties": { "avg_emv": { "type": "number" }, "avg_engagement_rate": { "type": "number" }, "avg_engagements": { "type": "number" }, "emv": { "type": "integer" }, "engagements": { "type": "integer" }, "impressions": { "type": "integer" }, "impressions_v2": { "type": "integer" }, "link_clicks": { "type": "integer" }, "number_of_media": { "type": "integer" }, "total_creator_likes": { "type": "integer" }, "video_views": { "type": "integer" }, "video_views_v2": { "type": "integer" } }, "type": "object" }, "CampaignStatsOverviewChannelsFacebookResponse": { "properties": { "avg_effectiveness_rate": { "type": "number" }, "avg_effectiveness_rate_v2": { "type": "number" }, "avg_engagement_rate": { "type": "number" }, "avg_engagement_rate_v2": { "type": "number" }, "avg_reach": { "type": "number" }, "avg_reach_v2": { "type": "number" }, "engagements": { "type": "integer" }, "engagements_v2": { "type": "integer" }, "impressions": { "type": "integer" }, "link_clicks": { "type": "integer" }, "number_of_media": { "type": "integer" }, "number_of_videos": { "type": "integer" }, "video_views": { "type": "integer" }, "views": { "type": "integer" }, "views_only_videos": { "type": "integer" } }, "type": "object" }, "CampaignStatsOverviewChannelsInstagramCreatorsResponse": { "properties": { "avg_engagement_rate": { "type": "number" }, "engagements": { "type": "integer" }, "impressions": { "type": "integer" }, "number_of_media": { "type": "integer" }, "views": { "type": "integer" } }, "type": "object" }, "CampaignStatsOverviewChannelsInstagramResponse": { "properties": { "avg_avg_watch_time_sec": { "type": "number" }, "avg_effectiveness_engagements_rate": { "type": "number" }, "avg_effectiveness_rate": { "type": "number" }, "avg_engagement_rate": { "type": "number" }, "avg_engagement_rate_views": { "type": "number" }, "avg_reach": { "type": "number" }, "engagements": { "type": "integer" }, "impressions": { "type": "integer" }, "number_of_media": { "type": "integer" }, "number_of_videos": { "type": "integer" }, "paid_engagements": { "type": "integer" }, "paid_impressions": { "type": "integer" }, "paid_video_views": { "type": "integer" }, "total_engagements": { "type": "integer" }, "total_impressions": { "type": "integer" }, "total_video_views": { "type": "integer" }, "video_views": { "type": "integer" }, "views": { "type": "integer" }, "views_only_videos": { "type": "integer" } }, "type": "object" }, "CampaignStatsOverviewChannelsInstagramStoryResponse": { "properties": { "avg_completion_rate": { "type": "number" }, "avg_completion_rate_views": { "type": "number" }, "avg_exit_rate": { "type": "number" }, "avg_exit_rate_views": { "type": "number" }, "avg_reach": { "type": "number" }, "exits": { "type": "integer" }, "impressions": { "type": "integer" }, "link_clicks": { "type": "integer" }, "number_of_media": { "type": "integer" }, "views": { "type": "integer" } }, "type": "object" }, "CampaignStatsOverviewChannelsLikeshopResponse": { "properties": { "link_clicks": { "type": "integer" } }, "type": "object" }, "CampaignStatsOverviewChannelsOwnedChannelsResponse": { "properties": { "avg_engagement_rate": { "type": "number" }, "avg_engagements": { "type": "number" }, "engagements": { "type": "integer" }, "impressions_v2": { "type": "integer" }, "link_clicks": { "type": "integer" }, "number_of_media": { "type": "integer" }, "video_views_v2": { "type": "integer" } }, "type": "object" }, "CampaignStatsOverviewChannelsPinterestResponse": { "properties": { "avg_engagement_rate": { "type": "number" }, "engagements": { "type": "number" }, "impressions": { "type": "integer" }, "link_clicks": { "type": "integer" }, "number_of_media": { "type": "integer" }, "number_of_videos": { "type": "integer" }, "saves": { "type": "integer" }, "video_views": { "type": "integer" } }, "type": "object" }, "CampaignStatsOverviewChannelsRelationshipsResponse": { "properties": { "avg_engagement_rate": { "type": "number" }, "comments": { "type": "integer" }, "engagements": { "type": "number" }, "likes": { "type": "integer" }, "number_of_media": { "type": "integer" }, "video_views": { "type": "integer" } }, "type": "object" }, "CampaignStatsOverviewChannelsResponse": { "properties": { "CUSTOM_METRICS": { "additionalProperties": { "type": "number" }, "type": "object" }, "FACEBOOK": { "$ref": "#/components/schemas/CampaignStatsOverviewChannelsFacebookResponse" }, "INSTAGRAM": { "$ref": "#/components/schemas/CampaignStatsOverviewChannelsInstagramResponse" }, "INSTAGRAM_CREATORS": { "$ref": "#/components/schemas/CampaignStatsOverviewChannelsInstagramCreatorsResponse" }, "INSTAGRAM_STORY": { "$ref": "#/components/schemas/CampaignStatsOverviewChannelsInstagramStoryResponse" }, "LIKESHOP": { "$ref": "#/components/schemas/CampaignStatsOverviewChannelsLikeshopResponse" }, "PINTEREST": { "$ref": "#/components/schemas/CampaignStatsOverviewChannelsPinterestResponse" }, "RELATIONSHIPS": { "$ref": "#/components/schemas/CampaignStatsOverviewChannelsRelationshipsResponse" }, "TIKTOK": { "$ref": "#/components/schemas/CampaignStatsOverviewChannelsTiktokResponse" }, "TIKTOK_CREATORS": { "$ref": "#/components/schemas/CampaignStatsOverviewChannelsTikTokCreatorsResponse" }, "TIKTOK_LIKESHOP": { "$ref": "#/components/schemas/CampaignStatsOverviewChannelsTiktokLikeshopResponse" }, "TWITTER": { "$ref": "#/components/schemas/CampaignStatsOverviewChannelsTwitterResponse" }, "UGC": { "$ref": "#/components/schemas/CampaignStatsOverviewChannelsUgcResponse" }, "YOUTUBE": { "$ref": "#/components/schemas/CampaignStatsOverviewChannelsYoutubeResponse" }, "overview": { "$ref": "#/components/schemas/CampaignStatsOverviewChannelsAllChannelsResponse" }, "owned_summary": { "$ref": "#/components/schemas/CampaignStatsOverviewChannelsOwnedChannelsResponse" } }, "type": "object" }, "CampaignStatsOverviewChannelsTikTokCreatorsResponse": { "properties": { "avg_engagement_rate": { "type": "number" }, "engagements": { "type": "integer" }, "number_of_media": { "type": "integer" }, "video_views": { "type": "integer" } }, "type": "object" }, "CampaignStatsOverviewChannelsTiktokLikeshopResponse": { "properties": { "link_clicks": { "type": "integer" } }, "type": "object" }, "CampaignStatsOverviewChannelsTiktokResponse": { "properties": { "avg_engagement_rate": { "type": "number" }, "avg_engagement_rate_views": { "type": "number" }, "avg_reach": { "type": "number" }, "avg_retention_rate": { "type": "number" }, "engagements": { "type": "number" }, "fyp_views_percentage": { "type": "number" }, "number_of_media": { "type": "integer" }, "video_views": { "type": "integer" } }, "type": "object" }, "CampaignStatsOverviewChannelsTwitterResponse": { "properties": { "avg_engagement_rate": { "type": "number" }, "avg_engagement_rate_organic": { "type": "number" }, "avg_engagement_rate_promoted": { "type": "number" }, "engagements": { "type": "number" }, "engagements_organic": { "type": "number" }, "engagements_promoted": { "type": "number" }, "impressions": { "type": "integer" }, "impressions_organic": { "type": "integer" }, "impressions_promoted": { "type": "integer" }, "likes": { "type": "integer" }, "likes_organic": { "type": "integer" }, "likes_promoted": { "type": "integer" }, "link_clicks": { "type": "integer" }, "link_clicks_organic": { "type": "integer" }, "link_clicks_promoted": { "type": "integer" }, "number_of_media": { "type": "integer" }, "number_of_videos": { "type": "integer" }, "video_views": { "type": "integer" }, "video_views_organic": { "type": "integer" }, "video_views_promoted": { "type": "integer" } }, "type": "object" }, "CampaignStatsOverviewChannelsUgcResponse": { "properties": { "avg_engagement_rate": { "type": "number" }, "engagements": { "type": "number" }, "estimated_reach": { "type": "number" }, "mentions": { "type": "integer" }, "number_of_media": { "type": "integer" }, "people_tags": { "type": "integer" } }, "type": "object" }, "CampaignStatsOverviewChannelsYoutubeResponse": { "properties": { "avg_view_duration": { "type": "number" }, "dislikes": { "type": "integer" }, "engagements": { "type": "number" }, "likes": { "type": "integer" }, "number_of_media": { "type": "integer" }, "video_views": { "type": "integer" }, "watch_time": { "type": "number" } }, "type": "object" }, "CampaignStatsOverviewResponseSechema": { "properties": { "data": { "$ref": "#/components/schemas/CampaignStatsOverviewChannelsResponse" } }, "type": "object" }, "CampaignStatsSentimentResponse": { "properties": { "data": { "$ref": "#/components/schemas/CampaignsStatsCommentSentimentResponse" } }, "type": "object" }, "CampaignStatsXlsxRequest": { "properties": { "end_date": { "description": "End date for campaign reporting period", "format": "date", "type": "string" }, "is_all_time": { "default": false, "description": "All time reporting period special preset", "type": "boolean" }, "socket_id": { "description": "WebSocket ID used to send events back to user", "type": "string" }, "start_date": { "description": "Start date for campaign reporting period", "format": "date", "type": "string" } }, "required": [ "end_date", "socket_id", "start_date" ], "type": "object" }, "CampaignTopKeywordsResponse": { "properties": { "data": { "description": "The sentiment counts for the top keyword matches", "type": "object" } }, "type": "object" }, "CampaignUgcMediaBulkUpdateJsonRequest": { "properties": { "gallery_ids": { "description": "A list of IDs indicating the gallery items to perform the action with.", "items": { "type": "integer" }, "type": "array" }, "media_ids": { "description": "A list of IDs indicating the media items to perform the action with.Selected media must belong to the specified campaign.", "items": { "type": "integer" }, "type": "array" } }, "type": "object" }, "CampaignUpdate": { "properties": { "benchmark_campaigns": { "description": "A list of campaign ids to benchmark the campaign against", "items": { "type": "integer" }, "nullable": true, "type": "array" }, "creator_filters": { "allOf": [ { "$ref": "#/components/schemas/CreatorFilters" } ], "description": "Filters to apply on the included creators" }, "creator_ids": { "description": "List of creator IDs to add to the campaign.", "items": { "type": "integer" }, "type": "array" }, "end_date": { "description": "A formatted datetime string in UTC.", "example": "2019-12-12", "nullable": true, "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(Z|((\\+|-)\\d{2}:\\d{2})))?$", "type": "string" }, "google_analytics_selected_campaigns": { "description": "A list of the selected google analytics campaigns.", "items": { "type": "string" }, "nullable": true, "type": "array" }, "hashtag_ids": { "description": "A list of hashtags added to the campaign.", "items": { "type": "integer" }, "type": "array" }, "name": { "description": "Name of the campaign.", "maxLength": 64, "minLength": 1, "type": "string" }, "start_date": { "description": "A formatted datetime string in UTC.", "example": "2019-12-01", "nullable": true, "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(Z|((\\+|-)\\d{2}:\\d{2})))?$", "type": "string" }, "topline_metrics": { "allOf": [ { "$ref": "#/components/schemas/TopLineMetrics" } ], "description": "Custom top line metrics and goals for the campaign", "nullable": true }, "ttcm_spark_ads_authorization_days": { "description": "Duration in which `ttcm_orders_invite_link` is valid (in days)", "nullable": true, "type": "integer" } }, "type": "object" }, "CampaignUpdateAdCampaignsRequest": { "properties": { "ad_campaigns": { "description": "A list of ad campaigns to update.", "items": { "$ref": "#/components/schemas/CampaignAdCampaign" }, "type": "array" } }, "required": [ "ad_campaigns" ], "type": "object" }, "Campaigns": { "properties": { "data": { "$ref": "#/components/schemas/Campaign1" }, "paging": { "$ref": "#/components/schemas/PagingData" } }, "type": "object" }, "CampaignsStatsCommentSentiment": { "properties": { "negative_sentiment": { "type": "integer" }, "neutral_sentiment": { "type": "integer" }, "positive_sentiment": { "type": "integer" } }, "type": "object" }, "CampaignsStatsCommentSentimentResponse": { "properties": { "FACEBOOK": { "$ref": "#/components/schemas/CampaignsStatsCommentSentiment" }, "INSTAGRAM": { "$ref": "#/components/schemas/CampaignsStatsCommentSentiment" }, "TIKTOK": { "$ref": "#/components/schemas/CampaignsStatsCommentSentiment" }, "TWITTER": { "$ref": "#/components/schemas/CampaignsStatsCommentSentiment" }, "YOUTUBE": { "$ref": "#/components/schemas/CampaignsStatsCommentSentiment" }, "overall": { "$ref": "#/components/schemas/CampaignsStatsCommentSentiment" } }, "type": "object" }, "ComparedCampaign": { "properties": { "cover_image": { "readOnly": true }, "id": { "type": "integer" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "CompetitorBrandDetails": { "properties": { "brand_id": { "description": "ID of the brand.", "type": "integer" }, "created_at": { "description": "time that the brand added the competitor.", "format": "date-time", "type": "string" } }, "required": [ "brand_id", "created_at" ], "type": "object" }, "CompetitorSearch": { "properties": { "brand_ids": { "description": "List of brand IDs to filter competitors by.", "items": { "type": "integer" }, "type": "array" }, "source": { "description": "Target channel of the competitor.", "enum": [ "INSTAGRAM", "YOUTUBE", "TWITTER", "FACEBOOK", "PINTEREST", "TIKTOK" ], "type": "string" }, "source_account_ids": { "description": "List of competitor source account IDs to filter by.", "items": { "type": "string" }, "type": "array" }, "source_list": { "description": "A list of target channels of the competitor.", "items": { "enum": [ "INSTAGRAM", "YOUTUBE", "TWITTER", "FACEBOOK", "PINTEREST", "TIKTOK" ], "type": "string" }, "type": "array" } }, "type": "object" }, "CompetitorSearchResponse": { "properties": { "avatar_url": { "description": "account avatar url.", "type": "string" }, "brand_details": { "description": "list of details of user accessible brands that have added the competitor.", "items": { "$ref": "#/components/schemas/CompetitorBrandDetails" }, "type": "array" }, "handle": { "description": "account handle.", "type": "string" }, "source": { "description": "Target channel of the competitor.", "enum": [ "INSTAGRAM", "YOUTUBE", "TWITTER", "FACEBOOK", "PINTEREST", "TIKTOK" ], "type": "string" }, "source_account_id": { "description": "competitor source account ID.", "type": "string" } }, "required": [ "avatar_url", "brand_details", "handle", "source", "source_account_id" ], "type": "object" }, "ConsumerEmailCapturedAt": { "properties": { "captured_at": { "format": "date-time", "type": "string" }, "email": { "maxLength": 145, "type": "string" } }, "required": [ "email" ], "type": "object" }, "ConsumerEmailCapturedAtResponse": { "properties": { "data": { "items": { "$ref": "#/components/schemas/ConsumerEmailCapturedAt" }, "type": "array" }, "paging": { "$ref": "#/components/schemas/PagingData" } }, "type": "object" }, "ContentAutomation": { "properties": { "brand_ids": { "description": "The brand IDs the content automation will be run for.", "items": { "type": "integer" }, "type": "array" }, "details": { "allOf": [ { "$ref": "#/components/schemas/ContentAutomationDetails" } ], "description": "The details that define how a content automation should run." }, "enabled": { "description": "Whether the content automation is enabled or not.", "type": "boolean" }, "id": { "description": "The ID of the content automation", "type": "integer" }, "name": { "description": "The name of the content automation.", "type": "string" }, "organization_id": { "description": "The ID for the organization the automation is assigned to.", "type": "integer" } }, "type": "object" }, "ContentAutomationActionResource": { "properties": { "deleted": { "description": "Included if the resource has been deleted.", "type": "boolean" }, "id": { "description": "The ID of the resource.", "type": "integer" }, "name": { "description": "The name of the resource.", "type": "string" } }, "required": [ "id" ], "type": "object" }, "ContentAutomationActions": { "properties": { "boards": { "description": "List of boards to add content to.", "items": { "$ref": "#/components/schemas/ContentAutomationActionResource" }, "type": "array" }, "campaigns": { "description": "List of campaigns to add content to.", "items": { "$ref": "#/components/schemas/ContentAutomationActionResource" }, "type": "array" }, "content_tags": { "description": "List of content tags to add to content.", "items": { "$ref": "#/components/schemas/ContentAutomationActionResource" }, "type": "array" }, "galleries": { "description": "List of galleries to add content to.", "items": { "$ref": "#/components/schemas/ContentAutomationActionResource" }, "type": "array" }, "hide_ugc": { "description": "Whether to hide matched UGC content.", "enum": [ true ], "type": "boolean" } }, "type": "object" }, "ContentAutomationBrandPromptCountResponse": { "properties": { "data": { "additionalProperties": { "type": "integer" }, "description": "Map of brand_id to number of prompts actively in use", "type": "object" } }, "type": "object" }, "ContentAutomationCountMatchingMedia": { "properties": { "brand_ids": { "description": "Selected brand IDs", "items": { "type": "integer" }, "type": "array" }, "details": { "allOf": [ { "$ref": "#/components/schemas/ContentAutomationDetails1" } ], "description": "The details that define how a content automation should run." } }, "required": [ "brand_ids", "details" ], "type": "object" }, "ContentAutomationCountMatchingMediaResponse": { "properties": { "count": { "description": "The count of matching media", "type": "integer" } }, "type": "object" }, "ContentAutomationCreate": { "properties": { "brand_ids": { "description": "The brand IDs the content automation will be run for.", "items": { "type": "integer" }, "minItems": 1, "type": "array" }, "details": { "allOf": [ { "$ref": "#/components/schemas/ContentAutomationDetails" } ], "description": "The details that define how a content automation should run." }, "enabled": { "default": true, "description": "Whether the content automation is enabled or not.", "type": "boolean" }, "name": { "description": "The name of the content automation.", "maxLength": 255, "minLength": 1, "type": "string" } }, "required": [ "brand_ids", "details", "name" ], "type": "object" }, "ContentAutomationDetails": { "properties": { "actions": { "allOf": [ { "$ref": "#/components/schemas/ContentAutomationActions" } ], "description": "Actions to take when running the automation." }, "channels": { "description": "List of channels used to target content for the automation.", "items": { "enum": [ "INSTAGRAM", "INSTAGRAM_UGC", "FACEBOOK", "X", "PINTEREST", "YOUTUBE", "LINKEDIN", "TIKTOK", "TIKTOK_UGC", "THREADS", "SNAPCHAT" ], "type": "string" }, "minItems": 1, "type": "array" }, "filters": { "allOf": [ { "$ref": "#/components/schemas/ContentAutomationFilters" } ], "description": "The filters used to target content for the automation." } }, "required": [ "actions", "channels", "filters" ], "type": "object" }, "ContentAutomationDetails1": { "properties": { "channels": { "description": "List of channels used to target content for the automation.", "items": { "enum": [ "INSTAGRAM", "INSTAGRAM_UGC", "FACEBOOK", "X", "PINTEREST", "YOUTUBE", "LINKEDIN", "TIKTOK", "TIKTOK_UGC", "THREADS", "SNAPCHAT" ], "type": "string" }, "minItems": 1, "type": "array" }, "filters": { "allOf": [ { "$ref": "#/components/schemas/ContentAutomationFilters" } ], "description": "The filters used to target content for the automation." } }, "required": [ "channels", "filters" ], "type": "object" }, "ContentAutomationFilters": { "properties": { "items": { "description": "List of filters to apply", "items": {}, "minItems": 1, "type": "array" }, "operator": { "description": "Specifies which operation to join the filter items with", "enum": [ "AND", "OR" ], "type": "string" } }, "required": [ "items", "operator" ], "type": "object" }, "ContentAutomationPreviewGeneratingResponse": { "properties": { "description": { "description": "Message informing the user about the generated task", "type": "string" }, "task_id": { "description": "The task ID of the generated task", "type": "string" } }, "type": "object" }, "ContentAutomationPreviewRequest": { "properties": { "brand_ids": { "description": "Selected brand IDs", "items": { "type": "integer" }, "type": "array" }, "details": { "allOf": [ { "$ref": "#/components/schemas/ContentAutomationDetails1" } ], "description": "The details that define how a content automation should run." } }, "required": [ "brand_ids", "details" ], "type": "object" }, "ContentAutomationPreviewResponse": { "properties": { "preview": { "description": "List of matching media objects", "items": { "$ref": "#/components/schemas/MediaV2" }, "maxItems": 20, "type": "array" }, "total_matches": { "description": "Total count of matching media", "type": "integer" } }, "type": "object" }, "ContentAutomationSearch": { "properties": { "brand_ids": { "description": "List of brand IDs to search for content automations with.", "items": { "type": "integer" }, "type": "array" }, "organization_ids": { "description": "List of organization IDs to search for content automations in.", "items": { "type": "integer" }, "type": "array" } }, "type": "object" }, "ContentAutomationSearchResult": { "properties": { "data": { "description": "List of content automations.", "items": { "$ref": "#/components/schemas/ContentAutomation" }, "type": "array" } }, "type": "object" }, "ContentAutomationUpdate": { "properties": { "brand_ids": { "description": "The brand IDs the content automation will be run for.", "items": { "type": "integer" }, "minItems": 1, "type": "array" }, "details": { "allOf": [ { "$ref": "#/components/schemas/ContentAutomationDetails" } ], "description": "The details that define how a content automation should run." }, "enabled": { "description": "Whether the content automation is enabled or not.", "type": "boolean" }, "name": { "description": "The name of the content automation.", "maxLength": 255, "minLength": 1, "type": "string" } }, "type": "object" }, "ContentTag": { "properties": { "brand_ids": { "description": "The Brand IDs to have access to the content tag.", "items": { "type": "integer" }, "minItems": 1, "type": "array" }, "created_at": { "description": "Timestamp of when the content tag was originally created.", "format": "date-time", "type": "string" }, "id": { "description": "ID of the content tag.", "type": "integer" }, "name": { "description": "content tag name.", "maxLength": 100, "minLength": 1, "type": "string" }, "organization_id": { "description": "ID of the organization that owns the content tag.", "type": "integer" }, "updated_at": { "description": "Timestamp of when the content tag was last updated.", "format": "date-time", "type": "string" } }, "required": [ "created_at", "id", "name", "organization_id", "updated_at" ], "type": "object" }, "ContentTagCreate": { "properties": { "brand_ids": { "description": "The Brand IDs to have access to the content tag.", "items": { "type": "integer" }, "type": "array" }, "name": { "description": "content tag name.", "maxLength": 100, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": "object" }, "ContentTagUpdate": { "properties": { "brand_ids": { "description": "The Brand IDs to be updated in the Content Tag.", "items": { "type": "integer" }, "type": "array" }, "name": { "description": "The Name to be updated in the Content Tag.", "maxLength": 100, "minLength": 1, "type": "string" } }, "type": "object" }, "CreateAffiliateLinkRequest": { "properties": { "creator_id": { "description": "Creator ID associated with the link", "type": "integer" }, "custom_back_half": { "description": "Custom back half for the bitly link", "nullable": true, "type": "string" }, "domain": { "description": "Domain for the bitly link (e.g., bit.ly or custom domain)", "nullable": true, "type": "string" }, "link_title": { "description": "Title of the affiliate link", "type": "string" }, "target_url": { "description": "The target URL for the affiliate link", "type": "string" }, "utm_parameters": { "allOf": [ { "$ref": "#/components/schemas/UtmParameters" } ], "description": "UTM parameters to append to the URL", "nullable": true } }, "required": [ "creator_id", "link_title", "target_url" ], "type": "object" }, "CreateAffiliateLinkResponse": { "properties": { "bitlink_id": { "description": "The Bitly link ID", "type": "string" }, "bitlink_url": { "description": "The Bitly short URL", "type": "string" }, "created_at": { "description": "Timestamp when the link was created", "format": "date-time", "type": "string" }, "creator_id": { "description": "ID of the creator associated with the link", "type": "integer" }, "custom_back_half": { "description": "Custom back half for the bitly link", "nullable": true, "type": "string" }, "domain": { "description": "Domain for the bitly link", "type": "string" }, "id": { "description": "ID of the affiliate link", "type": "integer" }, "link_title": { "description": "Title of the affiliate link", "type": "string" }, "long_url": { "description": "The full URL with UTM parameters", "type": "string" }, "target_url": { "description": "The target URL for the affiliate link", "type": "string" }, "utm_parameters": { "allOf": [ { "$ref": "#/components/schemas/UtmParameters" } ], "description": "UTM parameters applied to the URL", "nullable": true } }, "type": "object" }, "CreateMediaForManyBrandsRequest": { "properties": { "brand_ids": { "items": { "type": "integer" }, "minItems": 1, "type": "array" }, "brand_media_meta": { "$ref": "#/components/schemas/BrandMediaMeta" }, "meta": {}, "socket_id": { "type": "string" }, "source": { "type": "string" }, "source_created_at": { "type": "string" }, "source_id": { "type": "string" }, "thumbnail_url": { "format": "url", "type": "string" }, "type": { "type": "string" }, "url": { "format": "url", "type": "string" } }, "required": [ "brand_ids", "source", "source_created_at", "source_id", "type", "url" ], "type": "object" }, "CreateProductCatalogRequest": { "properties": { "source": { "description": "External source of the product catalog data", "enum": [ "facebook", "FACEBOOK" ], "minLength": 1, "type": "string" }, "source_id": { "description": "External source ID for the product catalog", "type": "string" } }, "required": [ "source", "source_id" ], "type": "object" }, "CreateSegmentClusterTagAssociationsRequest": { "properties": { "segment_cluster_ids": { "description": "List of cluster ids.", "items": { "type": "integer" }, "type": "array" }, "segment_cluster_tag_ids": { "description": "List of cluster tag ids.", "items": { "type": "integer" }, "type": "array" } }, "required": [ "segment_cluster_ids", "segment_cluster_tag_ids" ], "type": "object" }, "CreateSegmentClusterTagRequest": { "properties": { "color": { "default": "#452C2C", "type": "string" }, "name": { "type": "string" } }, "required": [ "name" ], "type": "object" }, "Creator": { "properties": { "avatar_url": { "description": "URL pointing to the media creators avatar", "type": "string" }, "handle": { "description": "Instagram handle of the media creator", "type": "string" } }, "type": "object" }, "CreatorAffiliateLinkData": { "properties": { "account_disconnected": { "description": "True if the link belongs to the same brand but a different Bitly account", "type": "boolean" }, "avatar_url": { "nullable": true, "type": "string" }, "bitlink_id": { "type": "string" }, "bitlink_url": { "type": "string" }, "campaign_id": { "type": "integer" }, "campaign_name": { "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "creator_id": { "type": "integer" }, "custom_back_half": { "nullable": true, "type": "string" }, "domain": { "type": "string" }, "id": { "type": "integer" }, "instagram_handle": { "nullable": true, "type": "string" }, "link_title": { "type": "string" }, "long_url": { "type": "string" }, "target_url": { "type": "string" }, "tiktok_handle": { "nullable": true, "type": "string" }, "updated_at": { "format": "date-time", "type": "string" }, "utm_parameters": { "allOf": [ { "$ref": "#/components/schemas/UtmParameters" } ], "nullable": true }, "youtube_handle": { "nullable": true, "type": "string" } }, "required": [ "bitlink_id", "bitlink_url", "campaign_id", "campaign_name", "created_at", "creator_id", "domain", "id", "link_title", "long_url", "target_url", "updated_at" ], "type": "object" }, "CreatorFilters": { "properties": { "excluded_media_ids": { "default": [], "items": { "type": "integer" }, "type": "array" }, "included_media_ids": { "default": [], "items": { "type": "integer" }, "type": "array" }, "source_created_at": { "allOf": [ { "$ref": "#/components/schemas/DateTimeRange" } ], "default": null, "nullable": true } }, "type": "object" }, "CreatorSummaryMetricItem": { "properties": { "goal": { "default": null, "description": "The goal value for this metric", "nullable": true, "type": "number" }, "metric": { "description": "The metric name. Must be one of total_posts, emv_views, avg_emv_views, likes, comments, avg_engagements, avg_engagement_rate", "enum": [ "total_posts", "emv_views", "avg_emv_views", "likes", "comments", "avg_engagements", "avg_engagement_rate" ], "type": "string" }, "source": { "description": "The source of the metric data. Must be one of creator_insights", "enum": [ "creator_insights" ], "type": "string" } }, "required": [ "metric", "source" ], "type": "object" }, "Crop": { "properties": { "height": { "description": "Height of crop in pixels.", "type": "number" }, "width": { "description": "Width of crop in pixels.", "type": "number" }, "x": { "description": "X position of top left corner of crop in pixels.", "type": "number" }, "y": { "description": "Y position of top left corner of crop in pixels.", "type": "number" } }, "type": "object" }, "CustomMetric": { "properties": { "aggregation": { "type": "string" }, "description": { "type": "string" }, "formula": { "type": "string" }, "id": { "type": "integer" }, "metric_format": { "type": "string" }, "name": { "type": "string" }, "value": { "type": "number" } }, "type": "object" }, "CustomMetricResponse": { "properties": { "custom_metrics": { "items": { "allOf": [ { "$ref": "#/components/schemas/CustomMetric" } ], "readOnly": true }, "type": "array" } }, "type": "object" }, "DateRangeFilters": { "properties": { "end": { "description": "End date of time range", "example": "2020-12-31", "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(Z|((\\+|-)\\d{2}:\\d{2})))?$", "type": "string" }, "start": { "description": "Start date of time range", "example": "2020-01-01", "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(Z|((\\+|-)\\d{2}:\\d{2})))?$", "type": "string" } }, "type": "object" }, "DateTimeRange": { "properties": { "end": { "type": "string" }, "start": { "type": "string" } }, "required": [ "end", "start" ], "type": "object" }, "EmailSubmissionSettingsRequest": { "properties": { "button_label": { "description": "Text to display on the email capture button", "nullable": true, "type": "string" }, "description": { "description": "Text to display above the email capture button", "nullable": true, "type": "string" }, "enabled": { "description": "Flag to set the email capture feature enabled or disabled", "type": "boolean" }, "privacy_policy_link": { "description": "Link to the publishers privacy policy", "nullable": true, "type": "string" } }, "required": [ "enabled" ], "type": "object" }, "EncodingRequest": { "properties": { "url": { "description": "The URL to the file to check encoding for.", "format": "url", "type": "string" } }, "required": [ "url" ], "type": "object" }, "EncodingResponse": { "properties": { "confidence": { "description": "Detection confidence", "type": "number" }, "encoding": { "description": "Detected file encoding", "type": "string" } }, "type": "object" }, "Error": { "properties": { "code": { "description": "Error code", "type": "integer" }, "errors": { "description": "Errors", "type": "object" }, "message": { "description": "Error message", "type": "string" }, "status": { "description": "Error name", "type": "string" } }, "type": "object" }, "ExportAffiliateLinksCSVRequest": { "properties": { "socket_id": { "description": "Socket ID for CSV generation notification", "type": "string" } }, "required": [ "socket_id" ], "type": "object" }, "FacebookFilters": { "properties": { "caption_keywords": { "$ref": "#/components/schemas/KeywordFilters" }, "is_boosted": { "description": "Is Media a boosted Facebook post", "type": "boolean" }, "post_types": { "items": { "description": "Post Type", "enum": [ "video", "VIDEO", "photo", "PHOTO", "carousel", "CAROUSEL", "text", "TEXT", "link", "LINK", "reel", "REEL" ], "example": "VIDEO", "type": "string" }, "type": "array" } }, "type": "object" }, "Galleries": { "properties": { "data": { "items": { "$ref": "#/components/schemas/Gallery" }, "type": "array" }, "paging": { "$ref": "#/components/schemas/PagingData" } }, "type": "object" }, "Gallery": { "properties": { "additional_stats": { "readOnly": true, "type": "object" }, "brand_id": { "type": "integer" }, "created_at": { "format": "date-time", "type": "string" }, "custom_content": { "allOf": [ { "$ref": "#/components/schemas/GalleryCustomContent" } ], "description": "Custom Gallery content such as banner or pinned media", "nullable": true, "readOnly": true }, "description": { "maxLength": 2000, "nullable": true, "type": "string" }, "extra_csv_data": { "nullable": true }, "fb_avg_effectiveness": { "nullable": true, "type": "number" }, "fb_avg_engagement_rate": { "nullable": true, "type": "number" }, "fb_avg_paid_and_organic_effectiveness_v2": { "nullable": true, "type": "number" }, "fb_avg_paid_and_organic_engagement_rate_v2": { "nullable": true, "type": "number" }, "fb_avg_paid_and_organic_reach_v2": { "nullable": true, "type": "number" }, "fb_avg_reach": { "nullable": true, "type": "number" }, "fb_total_engagements": { "nullable": true, "type": "integer" }, "fb_total_impressions": { "nullable": true, "type": "integer" }, "fb_total_paid_and_organic_engagements_v2": { "nullable": true, "type": "integer" }, "fb_total_paid_and_organic_views": { "nullable": true, "type": "integer" }, "gallery_distribution": { "allOf": [ { "$ref": "#/components/schemas/GalleryDistribution" } ], "readOnly": true }, "gallery_size": { "nullable": true, "type": "integer" }, "gallery_stats_updated": { "format": "date-time", "nullable": true, "type": "string" }, "gallery_type": { "default": "LIBRARY", "description": "Type of gallery.", "enum": [ "instagram", "INSTAGRAM", "instagram_likeshop", "INSTAGRAM_LIKESHOP", "pinterest", "PINTEREST", "library", "LIBRARY", "instagram_story", "INSTAGRAM_STORY", "instagram_story_narrative", "INSTAGRAM_STORY_NARRATIVE", "tiktok", "TIKTOK", "tiktok_likeshop", "TIKTOK_LIKESHOP", "facebook", "FACEBOOK", "twitter", "TWITTER", "youtube", "YOUTUBE", "linkedin", "LINKEDIN", "threads", "THREADS", "snapchat", "SNAPCHAT" ], "type": "string" }, "id": { "type": "integer" }, "ig_story_avg_completion_rate": { "readOnly": true, "type": "number" }, "ig_story_avg_completion_rate_views": { "readOnly": true, "type": "number" }, "ig_story_avg_exit_rate": { "nullable": true, "type": "number" }, "ig_story_avg_exit_rate_views": { "nullable": true, "type": "number" }, "ig_story_avg_impressions": { "readOnly": true, "type": "number" }, "ig_story_avg_reach": { "readOnly": true, "type": "number" }, "ig_story_avg_views": { "readOnly": true, "type": "number" }, "ig_story_narrative_time_range": { "allOf": [ { "$ref": "#/components/schemas/TimeRange" } ], "readOnly": true }, "ig_story_swipe_ups": { "readOnly": true, "type": "integer" }, "ig_story_total_impressions": { "nullable": true, "type": "integer" }, "ig_story_total_reach": { "nullable": true, "type": "integer" }, "ig_story_total_replies": { "nullable": true, "type": "integer" }, "ig_story_total_views": { "nullable": true, "type": "integer" }, "instagram_avg_effectiveness": { "nullable": true, "type": "number" }, "instagram_avg_effectiveness_engagements": { "nullable": true, "type": "number" }, "instagram_avg_engagement": { "nullable": true, "type": "number" }, "instagram_avg_reach": { "nullable": true, "type": "integer" }, "instagram_total_comments": { "nullable": true, "type": "integer" }, "instagram_total_likes": { "nullable": true, "type": "integer" }, "instagram_total_reach": { "nullable": true, "type": "integer" }, "label": { "maxLength": 256, "type": "string" }, "latest_media": { "items": { "$ref": "#/components/schemas/MediaPreview" }, "type": "array" }, "latest_media_published_at": { "format": "date-time", "nullable": true, "type": "string" }, "library_total_clicks": { "nullable": true, "type": "integer" }, "library_total_high_performing_photos": { "nullable": true, "type": "integer" }, "library_total_low_performing_photos": { "nullable": true, "type": "integer" }, "library_total_top_performing_photos": { "nullable": true, "type": "integer" }, "library_total_views": { "nullable": true, "type": "integer" }, "linkedin_avg_click_through_rate": { "nullable": true, "type": "number" }, "linkedin_avg_engagement_rate": { "nullable": true, "type": "number" }, "linkedin_avg_unique_impressions": { "nullable": true, "type": "number" }, "linkedin_total_impressions": { "nullable": true, "type": "integer" }, "linkedin_total_likes": { "nullable": true, "type": "integer" }, "live": { "nullable": true, "type": "integer" }, "name": { "maxLength": 256, "type": "string" }, "pinterest_avg_engagement_rate": { "nullable": true, "type": "number" }, "pinterest_total_clicks": { "nullable": true, "type": "integer" }, "pinterest_total_closeups": { "nullable": true, "type": "integer" }, "pinterest_total_comments": { "nullable": true, "type": "integer" }, "pinterest_total_impressions": { "nullable": true, "type": "integer" }, "pinterest_total_saves": { "nullable": true, "type": "integer" }, "pinterest_total_video_views": { "nullable": true, "type": "integer" }, "pinterest_total_visits": { "nullable": true, "type": "integer" }, "settings": { "nullable": true, "type": "object" }, "snapchat_avg_engagement_rate": { "nullable": true, "type": "number" }, "snapchat_avg_view_time": { "nullable": true, "type": "number" }, "snapchat_total_engagements": { "nullable": true, "type": "integer" }, "snapchat_total_viewers": { "nullable": true, "type": "integer" }, "snapchat_total_views": { "nullable": true, "type": "integer" }, "spirit_gallery_enabled": { "type": "integer" }, "tags": { "description": "List of gallery tags.", "items": { "$ref": "#/components/schemas/GalleryTags" }, "type": "array" }, "threads_avg_engagement_rate": { "nullable": true, "type": "number" }, "threads_total_engagements": { "nullable": true, "type": "integer" }, "threads_total_likes": { "nullable": true, "type": "integer" }, "threads_total_replies": { "nullable": true, "type": "integer" }, "threads_total_views": { "nullable": true, "type": "integer" }, "tiktok_avg_engagement_rate": { "nullable": true, "type": "number" }, "tiktok_avg_retention_rate": { "nullable": true, "type": "number" }, "tiktok_avg_video_views": { "nullable": true, "type": "number" }, "tiktok_total_reach": { "nullable": true, "type": "integer" }, "tiktok_total_video_views": { "nullable": true, "type": "integer" }, "twitter_avg_engagement_rate": { "nullable": true, "type": "number" }, "twitter_impressions": { "nullable": true, "type": "integer" }, "twitter_likes": { "nullable": true, "type": "integer" }, "twitter_retweets": { "nullable": true, "type": "integer" }, "twitter_total_engagements": { "nullable": true, "type": "integer" }, "updated_at": { "format": "date-time", "type": "string" }, "youtube_avg_view_duration": { "nullable": true, "type": "number" }, "youtube_subscribers": { "nullable": true, "type": "integer" }, "youtube_total_engagements": { "nullable": true, "type": "integer" }, "youtube_total_video_views": { "nullable": true, "type": "integer" }, "youtube_total_watch_time": { "nullable": true, "type": "integer" } }, "required": [ "brand_id", "name" ], "type": "object" }, "GalleryCustomContent": { "properties": { "banner": { "allOf": [ { "$ref": "#/components/schemas/GalleryMedia" } ], "description": "Gallery Media that serves as a banner image", "nullable": true }, "pinned": { "description": "List of Gallery Media that serves as pinned content.", "items": { "$ref": "#/components/schemas/GalleryMedia" }, "nullable": true, "type": "array" } }, "type": "object" }, "GalleryDistribution": { "properties": { "competitive_post_count": { "type": "integer" }, "owned_post_count": { "type": "integer" } }, "type": "object" }, "GalleryImportBoardMediaRequest": { "properties": { "gallery_name": { "description": "Name of the new gallery.", "minLength": 1, "type": "string" }, "gallery_type": { "enum": [ "instagram", "INSTAGRAM", "instagram_likeshop", "INSTAGRAM_LIKESHOP", "pinterest", "PINTEREST", "library", "LIBRARY", "instagram_story", "INSTAGRAM_STORY", "instagram_story_narrative", "INSTAGRAM_STORY_NARRATIVE", "tiktok", "TIKTOK", "tiktok_likeshop", "TIKTOK_LIKESHOP", "facebook", "FACEBOOK", "twitter", "TWITTER", "youtube", "YOUTUBE", "linkedin", "LINKEDIN", "threads", "THREADS", "snapchat", "SNAPCHAT" ], "type": "string" }, "post_urls": { "description": "A list of urls specifying the media to add to the gallery", "items": { "type": "string" }, "type": "array" } }, "required": [ "gallery_name", "gallery_type", "post_urls" ], "type": "object" }, "GalleryImportBoardMediaResponse": { "properties": { "gallery_created": { "type": "boolean" }, "gallery_id": { "type": "integer" }, "gallery_name": { "type": "string" }, "posts_added": { "items": { "type": "string" }, "type": "array" }, "posts_existing": { "items": { "type": "string" }, "type": "array" }, "posts_not_found": { "items": { "type": "string" }, "type": "array" } }, "required": [ "gallery_created", "gallery_id", "gallery_name" ], "type": "object" }, "GalleryLikeshopStat": { "properties": { "clicks": { "nullable": true, "type": "integer" }, "links": { "nullable": true, "type": "string" }, "tiktok_clicks": { "nullable": true, "type": "integer" } }, "type": "object" }, "GalleryLikeshopTotalStats": { "properties": { "media_with_link_count": { "type": "integer" }, "total_media": { "type": "integer" } }, "type": "object" }, "GalleryMedia": { "properties": { "brand_media_type": { "type": "string" }, "can_publish_within": { "allOf": [ { "$ref": "#/components/schemas/DateTimeRange" } ], "readOnly": true }, "clicks": { "type": "integer" }, "created_at": { "format": "date-time", "type": "string" }, "id": { "type": "integer" }, "media": { "$ref": "#/components/schemas/Media" }, "order": { "type": "number" }, "products": { "items": { "$ref": "#/components/schemas/GalleryMediaProduct" }, "type": "array" }, "updated_at": { "format": "date-time", "type": "string" } }, "type": "object" }, "GalleryMediaList": { "properties": { "data": { "items": { "$ref": "#/components/schemas/GalleryMedia" }, "type": "array" }, "paging": { "$ref": "#/components/schemas/PagingData" } }, "type": "object" }, "GalleryMediaListSchemaV2": { "properties": { "data": { "items": { "$ref": "#/components/schemas/GalleryMediaSchemaV2" }, "type": "array" }, "paging": { "$ref": "#/components/schemas/PagingData" } }, "type": "object" }, "GalleryMediaMultiRequest": { "properties": { "media_ids": { "description": "A list of IDs of the requested medias.", "items": { "type": "integer" }, "type": "array" } }, "type": "object" }, "GalleryMediaProduct": { "properties": { "archived": { "description": "Whether the product is archived.", "type": "boolean" }, "clicks": { "description": "Clicks of the product for this media.", "type": "integer" }, "created_at": { "format": "date-time", "type": "string" }, "description": { "description": "Description of the product.", "type": "string" }, "id": { "description": "ID of the object.", "readOnly": true, "type": "integer" }, "image_url": { "description": "Image URL of the product.", "type": "string" }, "product_groups": { "items": { "$ref": "#/components/schemas/ProductGroup" }, "type": "array" }, "product_overrides": { "items": { "$ref": "#/components/schemas/ProductOverride" }, "type": "array" }, "source_id": { "description": "Source ID of the product (SKU or brand's product ID).", "type": "string" }, "title": { "description": "Title of the product.", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" }, "url": { "description": "URL of the product.", "type": "string" }, "x": { "description": "X coordinate of the product displayed in this media.", "type": "number" }, "y": { "description": "Y coordinate of the product displayed in this media.", "type": "number" } }, "type": "object" }, "GalleryMediaProduct1": { "properties": { "archived": { "description": "Whether the product is archived.", "type": "boolean" }, "clicks": { "description": "Clicks of the product for this media.", "type": "integer" }, "created_at": { "format": "date-time", "type": "string" }, "description": { "description": "Description of the product.", "type": "string" }, "id": { "description": "ID of the object.", "readOnly": true, "type": "integer" }, "image_url": { "description": "Image URL of the product.", "type": "string" }, "product_overrides": { "items": { "$ref": "#/components/schemas/ProductOverride" }, "type": "array" }, "source_id": { "description": "Source ID of the product (SKU or brand's product ID).", "type": "string" }, "title": { "description": "Title of the product.", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" }, "url": { "description": "URL of the product.", "type": "string" }, "x": { "description": "X coordinate of the product displayed in this media.", "type": "number" }, "y": { "description": "Y coordinate of the product displayed in this media.", "type": "number" } }, "type": "object" }, "GalleryMediaSchemaV2": { "properties": { "brand_id": { "readOnly": true, "type": "integer" }, "brand_media_id": { "readOnly": true, "type": "integer" }, "brand_media_status": { "description": "Status of the brand media (e.g. PROCESSED, HIDDEN, NEW).", "readOnly": true, "type": "string" }, "callback_socket_id": { "description": "ID of WebSocket to notify when media conversion is complete.", "type": "string" }, "can_publish_within": { "allOf": [ { "$ref": "#/components/schemas/DateTimeRange" } ], "description": "Media is only allowed to be published within this range of dates.", "readOnly": true }, "caption_question": { "allOf": [ { "$ref": "#/components/schemas/SentimentQuestion" } ], "description": "Whether the caption of this media item includes a question.", "readOnly": true }, "caption_sentiment": { "allOf": [ { "$ref": "#/components/schemas/Sentiment" } ], "description": "Sentiment as determined by the caption of this media item.", "readOnly": true }, "clicks": { "description": "Clicks of the media in spirit gallery.", "type": "integer" }, "collections": { "description": "Collections that the media belong to.", "readOnly": true, "type": "object" }, "comment_sentiment": { "allOf": [ { "$ref": "#/components/schemas/Sentiment" } ], "description": "Sentiment as determined by the aggregated comments on this media item.", "readOnly": true }, "community_engagement": { "description": "Media engagement for community overview", "readOnly": true, "type": "integer" }, "content_rights_expiry_date": { "description": "Expiry date of the content rights.", "format": "date-time", "readOnly": true, "type": "string" }, "content_rights_requested_by": { "description": "User ID of the person who requested content rights.", "readOnly": true, "type": "string" }, "content_rights_requested_date": { "description": "Date when the content rights were requested.", "format": "date-time", "readOnly": true, "type": "string" }, "content_rights_type": { "description": "Content rights status of the media.", "enum": [ "APPROVED", "NOT_REQUESTED", "REQUESTED", "LAPSED", "FAILED", "EXPIRED" ], "readOnly": true, "type": "string" }, "content_tags": { "description": "content tag names that brand media can be tagged with", "example": [ "Tag 1", "Tag 2" ], "items": {}, "type": "array" }, "created_at": { "description": "An ISO-8601 formatted timestamp of when the object was created.", "format": "date-time", "readOnly": true, "type": "string" }, "creator": { "allOf": [ { "$ref": "#/components/schemas/Creator" } ], "description": "Creator info for the media", "readOnly": true }, "custom_metrics": { "items": { "allOf": [ { "$ref": "#/components/schemas/CustomMetric" } ], "readOnly": true }, "type": "array" }, "facebook": { "description": "Facebook source data.", "readOnly": true, "type": "object" }, "id": { "description": "The object's ID.", "readOnly": true, "type": "integer" }, "image": { "allOf": [ { "$ref": "#/components/schemas/ImageMedia" } ], "description": "Data if type is `IMAGE`." }, "instagram": { "description": "Instagram source data.", "readOnly": true, "type": "object" }, "instagram_ads": { "description": "Instagram ads source data.", "readOnly": true, "type": "object" }, "instagram_story": { "description": "Instagram story source data.", "readOnly": true, "type": "object" }, "instagram_story_frame": { "description": "Instagram story frame source data.", "readOnly": true, "type": "object" }, "instagram_user": { "description": "Instagram User source data.", "readOnly": true, "type": "object" }, "likeshop": { "allOf": [ { "$ref": "#/components/schemas/GalleryLikeshopStat" } ], "description": "Likeshop Stats." }, "linkedin": { "description": "LinkedIn source data.", "readOnly": true, "type": "object" }, "media_group": { "description": "Media group ID.", "readOnly": true, "type": "integer" }, "meta": { "allOf": [ { "$ref": "#/components/schemas/MediaV2Meta" } ], "description": "Metadata describing this media item." }, "pinterest": { "description": "Pinterest source data.", "readOnly": true, "type": "object" }, "predictions": { "allOf": [ { "$ref": "#/components/schemas/Predictions" } ], "description": "Contains vision predictions for this media. Only returned if `include` query param contains \"predictions\".", "readOnly": true }, "products": { "$ref": "#/components/schemas/GalleryMediaProduct1" }, "snapchat": { "description": "Snapchat source data.", "readOnly": true, "type": "object" }, "source": { "description": "Source of media.", "enum": [ "INSTAGRAM", "INSTAGRAM_STORY", "PINTEREST", "FACEBOOK", "TIKTOK", "TIKTOK_AD", "TWITTER", "YOUTUBE", "LINKEDIN", "THREADS", "SNAPCHAT", "UPLOAD", "EDITOR", "AI_GENERATION", "FACEBOOK_ADS", "FACEBOOK_LINK", "FACEBOOK_TEXT", "FACEBOOK_TEXT_LINK", "TWITTER_LINK", "TWITTER_TEXT" ], "type": "string" }, "source_account_id": { "description": "The native ID of the account that created this post, if applicable.", "readOnly": true, "type": "string" }, "source_created_at": { "description": "An ISO-8601 formatted timestamp of when the source object was created.", "format": "date-time", "type": "string" }, "source_id": { "description": "Source ID of media.", "readOnly": true, "type": "string" }, "source_type": { "description": "Type of source.", "enum": [ "UGC", "OWNED", "OTHER" ], "type": "string" }, "threads": { "description": "Threads source data.", "readOnly": true, "type": "object" }, "tiktok": { "description": "TikTok source data.", "readOnly": true, "type": "object" }, "tiktok_ad": { "description": "TikTok Ad source data.", "readOnly": true, "type": "object" }, "twitter": { "description": "Twitter source data.", "readOnly": true, "type": "object" }, "type": { "description": "Type of media.", "enum": [ "IMAGE", "VIDEO", "CAROUSEL", "REEL" ], "type": "string" }, "updated_at": { "description": "An ISO-8601 formatted timestamp of when the object was last updated.", "format": "date-time", "readOnly": true, "type": "string" }, "variants": { "description": "Variants of media: TEXT, LINK", "items": { "enum": [ "TEXT", "LINK" ], "type": "string" }, "type": "array" }, "video": { "allOf": [ { "$ref": "#/components/schemas/VideoMedia" } ], "description": "Data if type is `VIDEO`." }, "video_predictions": { "allOf": [ { "$ref": "#/components/schemas/VideoPredictions" } ], "description": "Contains vision predictions for video media, which is a list of prediction values by frame equidistant to the length of the video", "readOnly": true }, "video_predictions_interval_sec": { "description": "Time interval for sampled video predictions", "type": "number" }, "video_suggested_thumbnail_list": { "items": { "allOf": [ { "$ref": "#/components/schemas/VideoSuggestedThumbnail" } ], "description": "List of suggested thumbnails for higher engagement", "readOnly": true }, "type": "array" }, "visual_features": { "description": "Visual features string of this media", "readOnly": true, "type": "string" }, "youtube": { "description": "YouTube source data", "readOnly": true, "type": "object" } }, "required": [ "source", "type" ], "type": "object" }, "GalleryMediasCSVReport": { "properties": { "end_date": { "default": null, "description": "A formatted datetime string in UTC.", "example": "2019-12-12", "nullable": true, "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(Z|((\\+|-)\\d{2}:\\d{2})))?$", "type": "string" }, "limit": { "default": 100, "description": "Number of results to return in a single response.", "maximum": 1000, "minimum": 1, "type": "integer" }, "offset": { "default": 0, "description": "The offset of the first result to be returned.", "minimum": 0, "type": "integer" }, "socket_id": { "default": null, "description": "The socket id of the requesting entity.", "nullable": true, "type": "string" }, "sort": { "description": "Sort by field. \"-\" for descending.", "enum": [ "PUBLISHED_AT", "CREATED", "UPDATED", "ORDER", "VISITS", "ADDED", "POSTED", "CLICKS", "LIKESHOP_CLICKS", "PERFORMANCE", "VIDEO_VIEWS", "AVERAGE_VIDEO_WATCH_TIME", "INSTAGRAM_EFFECTIVENESS", "INSTAGRAM_REACH", "INSTAGRAM_ENGAGEMENT", "INSTAGRAM_ORGANIC_COMMENTS", "INSTAGRAM_PAID_COMMENTS", "INSTAGRAM_TOTAL_COMMENTS", "INSTAGRAM_ENGAGEMENT_RATE", "INSTAGRAM_ENGAGEMENT_RATE_VIEWS", "INSTAGRAM_ORGANIC_IMPRESSIONS", "INSTAGRAM_PAID_IMPRESSIONS", "INSTAGRAM_TOTAL_IMPRESSIONS", "INSTAGRAM_ORGANIC_LIKES", "INSTAGRAM_PAID_LIKES", "INSTAGRAM_TOTAL_LIKES", "INSTAGRAM_SAVES", "INSTAGRAM_TOTAL_ENGAGEMENTS", "INSTAGRAM_PAID_TOTAL_ENGAGEMENTS", "INSTAGRAM_SUM_TOTAL_ENGAGEMENTS", "INSTAGRAM_VIDEO_VIEWS", "INSTAGRAM_PAID_VIDEO_VIEWS", "INSTAGRAM_TOTAL_VIDEO_VIEWS", "INSTAGRAM_PAID_ENGAGEMENT_RATE", "INSTAGRAM_TOTAL_WATCH_TIME", "INSTAGRAM_STORY_REACH", "INSTAGRAM_STORY_IMPRESSIONS", "INSTAGRAM_STORY_SWIPE_UPS", "INSTAGRAM_STORY_REPLIES", "INSTAGRAM_STORY_EXIT_RATE", "PINTEREST_CLICKS", "PINTEREST_CLOSEUPS", "PINTEREST_COMMENTS", "PINTEREST_ENGAGEMENT", "PINTEREST_IMPRESSIONS", "PINTEREST_SAVES", "PINTEREST_VIDEO_VIEWS", "PINTEREST_AVERAGE_VIDEO_WATCH_TIME", "PINTEREST_ENGAGEMENTS", "DATE", "INSTAGRAM_STORY_FRAME_REACH", "INSTAGRAM_STORY_FRAME_IMPRESSIONS", "INSTAGRAM_STORY_FRAME_COMPLETION_RATE", "INSTAGRAM_STORY_FRAME_EXITS", "INSTAGRAM_STORY_FRAME_EXIT_RATE", "INSTAGRAM_STORY_FRAME_SWIPE_UPS", "INSTAGRAM_STORY_FRAME_REPLIES", "INSTAGRAM_STORY_FRAME_TAPS_BACK", "INSTAGRAM_STORY_FRAME_TAPS_FORWARD", "FACEBOOK_PHOTO_VIEW_CLICKS", "FACEBOOK_POST_CLICKS", "FACEBOOK_COMMENTS", "FACEBOOK_REACH", "FACEBOOK_EFFECTIVENESS", "FACEBOOK_REACTIONS", "FACEBOOK_ENGAGEMENT_RATE", "FACEBOOK_ENGAGEMENT_RATE_PUBLIC", "FACEBOOK_SHARES", "FACEBOOK_IMPRESSIONS", "FACEBOOK_TOTAL_ENGAGEMENTS", "FACEBOOK_TOTAL_ENGAGEMENTS_PUBLIC", "FACEBOOK_LINK_CLICKS", "FACEBOOK_VIDEO_COMPLETE_VIEWS", "FACEBOOK_OTHER_CLICKS", "FACEBOOK_VIDEO_VIEWS", "FACEBOOK_REELS_POST_VIDEO_VIEW_TIME", "FACEBOOK_REELS_POST_IMPRESSIONS_UNIQUE", "TWITTER_ENGAGEMENT_RATE", "TWITTER_IMPRESSIONS", "TWITTER_URL_CLICKS", "TWITTER_USER_PROFILE_CLICKS", "TWITTER_QUOTE_TWEETS", "TWITTER_REPLIES", "TWITTER_RETWEETS", "TWITTER_TOTAL_ENGAGEMENTS", "TWITTER_TOTAL_RETWEETS", "TWITTER_FOLLOWS", "TWITTER_VIDEO_VIEWS", "TIKTOK_REACH", "TIKTOK_AVERAGE_TIME_WATCHED", "TIKTOK_AVERAGE_COMPLETION_RATE", "TIKTOK_COMMENTS", "TIKTOK_IMPRESSIONS_SEARCH_RATE", "TIKTOK_FULL_VIDEO_WATCHED_RATE", "TIKTOK_SHARES", "TIKTOK_ENGAGEMENT_RATE", "TIKTOK_ENTERTAINMENT_SCORE", "TIKTOK_IMPRESSIONS_SOUND_RATE", "TIKTOK_IMPRESSIONS_FOLLOW_RATE", "TIKTOK_TOTAL_ENGAGEMENTS", "TIKTOK_IMPRESSIONS_FOR_YOU_RATE", "TIKTOK_TOTAL_TIME_WATCHED", "TIKTOK_IMPRESSIONS_HASHTAG_RATE", "TIKTOK_DURATION", "TIKTOK_LIKES", "TIKTOK_VIEWS", "TIKTOK_IMPRESSIONS_PERSONAL_PROFILE_RATE", "YOUTUBE_AVG_VIEW_PERCENTAGE", "YOUTUBE_AVG_VIEW_DURATION", "YOUTUBE_CARD_IMPRESSIONS", "YOUTUBE_CARD_CLICKS", "YOUTUBE_CARD_CLICK_RATE", "YOUTUBE_CARD_TEASER_CLICKS", "YOUTUBE_CARD_TEASER_CLICK_RATE", "YOUTUBE_CARD_TEASER_IMPRESSIONS", "YOUTUBE_COMMENTS", "YOUTUBE_DISLIKES", "YOUTUBE_LIKES", "YOUTUBE_PREMIUM_VIEWS", "YOUTUBE_EST_PREMIUM_SECONDS_WATCHED", "YOUTUBE_SHARES", "YOUTUBE_SUBSCRIBERS", "YOUTUBE_ENGAGEMENTS", "YOUTUBE_VIDEOS_ADDED_TO_PLAYLIST", "YOUTUBE_VIEWS", "YOUTUBE_EST_SECONDS_WATCHED", "LINKEDIN_CLICK_THROUGH_RATE", "LINKEDIN_CLICKS", "LINKEDIN_COMMENTS", "LINKEDIN_ENGAGEMENTS", "LINKEDIN_ENGAGEMENT_RATE", "LINKEDIN_IMPRESSIONS", "LINKEDIN_LIKES", "LINKEDIN_SHARES", "LINKEDIN_UNIQUE_IMPRESSIONS", "LINKEDIN_VIDEO_ANALYTICS_VIDEO_VIEWS", "LINKEDIN_VIDEO_ANALYTICS_TIME_WATCHED_FOR_VIEWS", "THREADS_ENGAGEMENTS", "THREADS_ENGAGEMENT_RATE", "THREADS_LIKES", "THREADS_QUOTES", "THREADS_REPLIES", "THREADS_REPOSTS", "THREADS_REPOSTS_AND_QUOTES", "THREADS_SHARES", "THREADS_VIEWS", "SNAPCHAT_AVG_VIEW_TIME_SECONDS", "SNAPCHAT_COMPLETES", "SNAPCHAT_ENGAGEMENT_RATE", "SNAPCHAT_ENGAGEMENTS", "SNAPCHAT_FAVORITES", "SNAPCHAT_INTERACTIONS", "SNAPCHAT_REPLIES", "SNAPCHAT_SHARES", "SNAPCHAT_SWIPE_DOWNS", "SNAPCHAT_SWIPE_UPS", "SNAPCHAT_UNIQUE_SESSIONS", "SNAPCHAT_VIEW_TIME_SECONDS", "SNAPCHAT_VIEWERS", "SNAPCHAT_VIEWS", "-PUBLISHED_AT", "-CREATED", "-UPDATED", "-ORDER", "-VISITS", "-ADDED", "-POSTED", "-CLICKS", "-LIKESHOP_CLICKS", "-PERFORMANCE", "-VIDEO_VIEWS", "-AVERAGE_VIDEO_WATCH_TIME", "-INSTAGRAM_EFFECTIVENESS", "-INSTAGRAM_REACH", "-INSTAGRAM_ENGAGEMENT", "-INSTAGRAM_ORGANIC_COMMENTS", "-INSTAGRAM_PAID_COMMENTS", "-INSTAGRAM_TOTAL_COMMENTS", "-INSTAGRAM_ENGAGEMENT_RATE", "-INSTAGRAM_ENGAGEMENT_RATE_VIEWS", "-INSTAGRAM_ORGANIC_IMPRESSIONS", "-INSTAGRAM_PAID_IMPRESSIONS", "-INSTAGRAM_TOTAL_IMPRESSIONS", "-INSTAGRAM_ORGANIC_LIKES", "-INSTAGRAM_PAID_LIKES", "-INSTAGRAM_TOTAL_LIKES", "-INSTAGRAM_SAVES", "-INSTAGRAM_TOTAL_ENGAGEMENTS", "-INSTAGRAM_PAID_TOTAL_ENGAGEMENTS", "-INSTAGRAM_SUM_TOTAL_ENGAGEMENTS", "-INSTAGRAM_VIDEO_VIEWS", "-INSTAGRAM_PAID_VIDEO_VIEWS", "-INSTAGRAM_TOTAL_VIDEO_VIEWS", "-INSTAGRAM_PAID_ENGAGEMENT_RATE", "-INSTAGRAM_TOTAL_WATCH_TIME", "-INSTAGRAM_STORY_REACH", "-INSTAGRAM_STORY_IMPRESSIONS", "-INSTAGRAM_STORY_SWIPE_UPS", "-INSTAGRAM_STORY_REPLIES", "-INSTAGRAM_STORY_EXIT_RATE", "-PINTEREST_CLICKS", "-PINTEREST_CLOSEUPS", "-PINTEREST_COMMENTS", "-PINTEREST_ENGAGEMENT", "-PINTEREST_IMPRESSIONS", "-PINTEREST_SAVES", "-PINTEREST_VIDEO_VIEWS", "-PINTEREST_AVERAGE_VIDEO_WATCH_TIME", "-PINTEREST_ENGAGEMENTS", "-DATE", "-INSTAGRAM_STORY_FRAME_REACH", "-INSTAGRAM_STORY_FRAME_IMPRESSIONS", "-INSTAGRAM_STORY_FRAME_COMPLETION_RATE", "-INSTAGRAM_STORY_FRAME_EXITS", "-INSTAGRAM_STORY_FRAME_EXIT_RATE", "-INSTAGRAM_STORY_FRAME_SWIPE_UPS", "-INSTAGRAM_STORY_FRAME_REPLIES", "-INSTAGRAM_STORY_FRAME_TAPS_BACK", "-INSTAGRAM_STORY_FRAME_TAPS_FORWARD", "-FACEBOOK_PHOTO_VIEW_CLICKS", "-FACEBOOK_POST_CLICKS", "-FACEBOOK_COMMENTS", "-FACEBOOK_REACH", "-FACEBOOK_EFFECTIVENESS", "-FACEBOOK_REACTIONS", "-FACEBOOK_ENGAGEMENT_RATE", "-FACEBOOK_ENGAGEMENT_RATE_PUBLIC", "-FACEBOOK_SHARES", "-FACEBOOK_IMPRESSIONS", "-FACEBOOK_TOTAL_ENGAGEMENTS", "-FACEBOOK_TOTAL_ENGAGEMENTS_PUBLIC", "-FACEBOOK_LINK_CLICKS", "-FACEBOOK_VIDEO_COMPLETE_VIEWS", "-FACEBOOK_OTHER_CLICKS", "-FACEBOOK_VIDEO_VIEWS", "-FACEBOOK_REELS_POST_VIDEO_VIEW_TIME", "-FACEBOOK_REELS_POST_IMPRESSIONS_UNIQUE", "-TWITTER_ENGAGEMENT_RATE", "-TWITTER_IMPRESSIONS", "-TWITTER_URL_CLICKS", "-TWITTER_USER_PROFILE_CLICKS", "-TWITTER_QUOTE_TWEETS", "-TWITTER_REPLIES", "-TWITTER_RETWEETS", "-TWITTER_TOTAL_ENGAGEMENTS", "-TWITTER_TOTAL_RETWEETS", "-TWITTER_FOLLOWS", "-TWITTER_VIDEO_VIEWS", "-TIKTOK_REACH", "-TIKTOK_AVERAGE_TIME_WATCHED", "-TIKTOK_AVERAGE_COMPLETION_RATE", "-TIKTOK_COMMENTS", "-TIKTOK_IMPRESSIONS_SEARCH_RATE", "-TIKTOK_FULL_VIDEO_WATCHED_RATE", "-TIKTOK_SHARES", "-TIKTOK_ENGAGEMENT_RATE", "-TIKTOK_ENTERTAINMENT_SCORE", "-TIKTOK_IMPRESSIONS_SOUND_RATE", "-TIKTOK_IMPRESSIONS_FOLLOW_RATE", "-TIKTOK_TOTAL_ENGAGEMENTS", "-TIKTOK_IMPRESSIONS_FOR_YOU_RATE", "-TIKTOK_TOTAL_TIME_WATCHED", "-TIKTOK_IMPRESSIONS_HASHTAG_RATE", "-TIKTOK_DURATION", "-TIKTOK_LIKES", "-TIKTOK_VIEWS", "-TIKTOK_IMPRESSIONS_PERSONAL_PROFILE_RATE", "-YOUTUBE_AVG_VIEW_PERCENTAGE", "-YOUTUBE_AVG_VIEW_DURATION", "-YOUTUBE_CARD_IMPRESSIONS", "-YOUTUBE_CARD_CLICKS", "-YOUTUBE_CARD_CLICK_RATE", "-YOUTUBE_CARD_TEASER_CLICKS", "-YOUTUBE_CARD_TEASER_CLICK_RATE", "-YOUTUBE_CARD_TEASER_IMPRESSIONS", "-YOUTUBE_COMMENTS", "-YOUTUBE_DISLIKES", "-YOUTUBE_LIKES", "-YOUTUBE_PREMIUM_VIEWS", "-YOUTUBE_EST_PREMIUM_SECONDS_WATCHED", "-YOUTUBE_SHARES", "-YOUTUBE_SUBSCRIBERS", "-YOUTUBE_ENGAGEMENTS", "-YOUTUBE_VIDEOS_ADDED_TO_PLAYLIST", "-YOUTUBE_VIEWS", "-YOUTUBE_EST_SECONDS_WATCHED", "-LINKEDIN_CLICK_THROUGH_RATE", "-LINKEDIN_CLICKS", "-LINKEDIN_COMMENTS", "-LINKEDIN_ENGAGEMENTS", "-LINKEDIN_ENGAGEMENT_RATE", "-LINKEDIN_IMPRESSIONS", "-LINKEDIN_LIKES", "-LINKEDIN_SHARES", "-LINKEDIN_UNIQUE_IMPRESSIONS", "-LINKEDIN_VIDEO_ANALYTICS_VIDEO_VIEWS", "-LINKEDIN_VIDEO_ANALYTICS_TIME_WATCHED_FOR_VIEWS", "-THREADS_ENGAGEMENTS", "-THREADS_ENGAGEMENT_RATE", "-THREADS_LIKES", "-THREADS_QUOTES", "-THREADS_REPLIES", "-THREADS_REPOSTS", "-THREADS_REPOSTS_AND_QUOTES", "-THREADS_SHARES", "-THREADS_VIEWS", "-SNAPCHAT_AVG_VIEW_TIME_SECONDS", "-SNAPCHAT_COMPLETES", "-SNAPCHAT_ENGAGEMENT_RATE", "-SNAPCHAT_ENGAGEMENTS", "-SNAPCHAT_FAVORITES", "-SNAPCHAT_INTERACTIONS", "-SNAPCHAT_REPLIES", "-SNAPCHAT_SHARES", "-SNAPCHAT_SWIPE_DOWNS", "-SNAPCHAT_SWIPE_UPS", "-SNAPCHAT_UNIQUE_SESSIONS", "-SNAPCHAT_VIEW_TIME_SECONDS", "-SNAPCHAT_VIEWERS", "-SNAPCHAT_VIEWS" ], "type": "string" }, "start_date": { "default": null, "description": "A formatted datetime string in UTC.", "example": "2019-12-01", "nullable": true, "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(Z|((\\+|-)\\d{2}:\\d{2})))?$", "type": "string" }, "token": { "default": null, "description": "The auth token of the socket connection.", "nullable": true, "type": "string" }, "type": { "description": "The CSV type.", "type": "string" }, "with_products_only": { "default": false, "description": "Only return media that have products.", "type": "boolean" } }, "required": [ "type" ], "type": "object" }, "GalleryOrderRequest": { "properties": { "after": { "nullable": true, "type": "integer" }, "media_id": { "type": "integer" } }, "type": "object" }, "GalleryPost": { "properties": { "description": { "description": "Description of the new gallery.", "nullable": true, "type": "string" }, "duplicate": { "description": "ID of the gallery to duplicate.", "nullable": true, "type": "integer" }, "duplicate_filter": { "description": "Only duplicate media from this source type.", "nullable": true, "type": "string" }, "gallery_type": { "description": "Type of gallery to create.", "enum": [ "instagram", "INSTAGRAM", "instagram_likeshop", "INSTAGRAM_LIKESHOP", "pinterest", "PINTEREST", "library", "LIBRARY", "instagram_story", "INSTAGRAM_STORY", "instagram_story_narrative", "INSTAGRAM_STORY_NARRATIVE", "tiktok", "TIKTOK", "tiktok_likeshop", "TIKTOK_LIKESHOP", "facebook", "FACEBOOK", "twitter", "TWITTER", "youtube", "YOUTUBE", "linkedin", "LINKEDIN", "threads", "THREADS", "snapchat", "SNAPCHAT" ], "type": "string" }, "name": { "description": "Name of the new gallery.", "minLength": 1, "type": "string" }, "tags": { "description": "List of tags for the new gallery.", "items": { "type": "string" }, "type": "array" } }, "required": [ "gallery_type", "name" ], "type": "object" }, "GallerySearchRequest": { "properties": { "brand_ids": { "description": "List of brand IDs to filter by", "items": { "type": "integer" }, "minItems": 1, "type": "array" }, "limit": { "maximum": 10000, "minimum": 0, "type": "integer" }, "search": { "description": "Search term to filter galleries/boards by", "type": "string" }, "types": { "description": "Comma separated list of gallery types", "items": { "enum": [ "INSTAGRAM", "INSTAGRAM_LIKESHOP", "PINTEREST", "LIBRARY", "INSTAGRAM_STORY", "INSTAGRAM_STORY_NARRATIVE", "TIKTOK", "TIKTOK_LIKESHOP", "FACEBOOK", "TWITTER", "YOUTUBE", "LINKEDIN", "THREADS", "SNAPCHAT" ], "type": "string" }, "minItems": 1, "type": "array" } }, "required": [ "brand_ids", "search", "types" ], "type": "object" }, "GallerySearchResponse": { "properties": { "data": { "additionalProperties": { "items": { "$ref": "#/components/schemas/Gallery" }, "type": "array" }, "type": "object" } }, "type": "object" }, "GalleryStatsCSVReport": { "properties": { "message": { "description": "Generating gallery media CSV report for brand", "type": "string" }, "task_id": { "description": "ID of the task performed", "type": "string" } }, "type": "object" }, "GalleryTag": { "properties": { "brand_id": { "type": "integer" }, "color": { "maxLength": 9, "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "id": { "type": "integer" }, "name": { "maxLength": 64, "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "brand_id", "color", "name" ], "type": "object" }, "GalleryTagOperation": { "properties": { "tags": { "description": "A list of gallery tags.", "items": { "type": "string" }, "type": "array" } }, "required": [ "tags" ], "type": "object" }, "GalleryTags": { "properties": { "color": { "maxLength": 9, "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "id": { "type": "integer" }, "name": { "maxLength": 64, "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "color", "name" ], "type": "object" }, "GalleryTransferResponse": { "properties": { "brand_id": { "type": "integer" }, "brand_label": { "maxLength": 64, "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "deleted": { "nullable": true, "type": "integer" }, "deleted_at": { "format": "date-time", "nullable": true, "type": "string" }, "gallery_id": { "nullable": true, "type": "integer" }, "gallery_name": { "maxLength": 256, "nullable": true, "type": "string" }, "id": { "type": "integer" }, "last_error": { "nullable": true, "type": "string" }, "slack_user_id": { "maxLength": 22, "nullable": true, "type": "string" }, "stage": { "enum": [ "FINISHED", "FORMATTING_EXTERNAL_DATA", "GATHERING_EXTERNAL_DATA", "INITIALIZING_GALLERY", "ORDERING_GALLERY_MEDIA", "PROCESSING_MEDIA", "PROCESSING_PRODUCTS", "QUEUED" ], "type": "string" }, "type": { "enum": [ "CURALATE_LIKESHOP", "LINKINBIO_LIKESHOP", "SPRINKLR_LIKESHOP", "SPROUT_LIKESHOP", "CURALATE_GALLERY" ], "type": "string" }, "updated_at": { "format": "date-time", "type": "string" }, "url": { "maxLength": 1000, "type": "string" } }, "required": [ "brand_id", "brand_label", "url" ], "type": "object" }, "GalleryUpdate": { "properties": { "description": { "default": null, "description": "Description of the gallery.", "nullable": true, "type": "string" }, "name": { "description": "Name of the gallery.", "type": "string" }, "settings": { "description": "Gallery settings.", "nullable": true, "type": "object" }, "spirit_gallery_enabled": { "description": "Is Spirit Gallery enabled for this gallery?", "type": "integer" }, "tags": { "description": "List of tags for Gallery.", "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "GalleryUpdateTag": { "properties": { "brand_id": { "description": "The Dash Social assigned ID of the brand.", "nullable": true, "type": "integer" }, "color": { "description": "The color of the tag.", "type": "string" }, "name": { "description": "The name of the tag.", "type": "string" } }, "type": "object" }, "GetCampaignAffiliateLinksResponse": { "properties": { "data": { "items": { "$ref": "#/components/schemas/CampaignAffiliateLinkData" }, "type": "array" }, "paging": { "$ref": "#/components/schemas/PagingData" } }, "required": [ "data", "paging" ], "type": "object" }, "GetCreatorAffiliateLinksResponse": { "properties": { "data": { "items": { "$ref": "#/components/schemas/CreatorAffiliateLinkData" }, "type": "array" }, "paging": { "$ref": "#/components/schemas/PagingData" } }, "required": [ "data", "paging" ], "type": "object" }, "GoogleAnalyticsAccount": { "properties": { "id": { "description": "GA Account ID", "type": "string" }, "name": { "description": "GA Account name", "type": "string" }, "properties": { "items": { "$ref": "#/components/schemas/GoogleAnalyticsProperty" }, "type": "array" }, "type": { "description": "Type of Google Analytics: Universal or GA4", "type": "string" } }, "type": "object" }, "GoogleAnalyticsAccountMetadata": { "properties": { "currency_code": { "type": "string" }, "timezone": { "type": "string" } }, "required": [ "currency_code", "timezone" ], "type": "object" }, "GoogleAnalyticsAccountResponse": { "properties": { "brand_id": { "type": "integer" }, "created_at": { "format": "date-time", "type": "string" }, "currency_code": { "maxLength": 5, "type": "string" }, "deleted": { "nullable": true, "type": "integer" }, "deleted_at": { "format": "date-time", "nullable": true, "type": "string" }, "ga_account_id": { "maxLength": 50, "type": "string" }, "ga_account_name": { "maxLength": 255, "type": "string" }, "ga_property_id": { "maxLength": 50, "type": "string" }, "ga_property_name": { "maxLength": 255, "type": "string" }, "ga_view_id": { "maxLength": 50, "type": "string" }, "ga_view_name": { "maxLength": 255, "type": "string" }, "id": { "type": "integer" }, "timezone": { "maxLength": 50, "type": "string" }, "type": { "enum": [ "ga4", "ua" ], "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "brand_id", "currency_code", "ga_account_id", "ga_account_name", "ga_property_id", "ga_property_name", "ga_view_id", "ga_view_name" ], "type": "object" }, "GoogleAnalyticsCreateAccount": { "properties": { "account_id": { "description": "Google Analytics account ID", "type": "string" }, "account_name": { "description": "Google Analytics account name", "type": "string" }, "brand_id": { "description": "Brand ID of the associated Google Analytics Account", "type": "integer" }, "property_id": { "description": "Google Analytics property ID", "type": "string" }, "property_name": { "description": "Google Analytics property name", "type": "string" }, "view_id": { "description": "Google Universal Analytics view ID. Not required with GA4", "type": "string" }, "view_name": { "description": "Googl Universal Analytics view name. Not required with GA4", "type": "string" } }, "type": "object" }, "GoogleAnalyticsDimensionFilter": { "properties": { "dimension_name": { "enum": [ "sourceMedium", "source", "medium", "campaign", "keyword", "adContent", "date", "country" ], "type": "string" }, "operator": { "enum": [ "regexp", "REGEXP", "begins_with", "BEGINS_WITH", "ends_with", "ENDS_WITH", "partial", "PARTIAL", "exact", "EXACT", "numeric_equal", "NUMERIC_EQUAL", "numeric_greater_than", "NUMERIC_GREATER_THAN", "numeric_less_than", "NUMERIC_LESS_THAN", "in_list", "IN_LIST" ], "type": "string" }, "value": { "items": { "type": "string" }, "type": "array" } }, "required": [ "dimension_name", "operator", "value" ], "type": "object" }, "GoogleAnalyticsDimensionFilterClause": { "properties": { "filters": { "items": { "$ref": "#/components/schemas/GoogleAnalyticsDimensionFilter" }, "type": "array" }, "operator": { "enum": [ "or", "OR", "and", "AND" ], "type": "string" } }, "required": [ "filters", "operator" ], "type": "object" }, "GoogleAnalyticsMetricFilter": { "properties": { "metric_name": { "enum": [ "sessions", "transactions", "revenue", "conversions", "bounceRate", "totalUsers", "ecommerceConversionRate" ], "type": "string" }, "operator": { "enum": [ "equal", "EQUAL", "less_than", "LESS_THAN", "greater_than", "GREATER_THAN", "is_missing", "IS_MISSING" ], "type": "string" }, "value": { "type": "string" } }, "required": [ "metric_name", "operator", "value" ], "type": "object" }, "GoogleAnalyticsMetricFilterClause": { "properties": { "filters": { "items": { "$ref": "#/components/schemas/GoogleAnalyticsMetricFilter" }, "type": "array" }, "operator": { "enum": [ "or", "OR", "and", "AND" ], "type": "string" } }, "required": [ "filters", "operator" ], "type": "object" }, "GoogleAnalyticsProperty": { "properties": { "id": { "description": "GA Property ID", "type": "string" }, "name": { "description": "GA Property name", "type": "string" }, "views": { "items": { "$ref": "#/components/schemas/GoogleAnalyticsView" }, "type": "array" } }, "type": "object" }, "GoogleAnalyticsReportDateRange": { "properties": { "end_date": { "type": "string" }, "start_date": { "type": "string" } }, "required": [ "end_date", "start_date" ], "type": "object" }, "GoogleAnalyticsReportRequest": { "properties": { "date_range": { "$ref": "#/components/schemas/GoogleAnalyticsReportDateRange" }, "dimension_filter": { "$ref": "#/components/schemas/GoogleAnalyticsDimensionFilterClause" }, "dimensions": { "items": { "enum": [ "sourceMedium", "source", "medium", "campaign", "keyword", "adContent", "date", "country" ], "type": "string" }, "minItems": 1, "type": "array" }, "metric_filter": { "$ref": "#/components/schemas/GoogleAnalyticsMetricFilterClause" }, "metrics": { "items": { "enum": [ "sessions", "transactions", "revenue", "conversions", "bounceRate", "totalUsers", "ecommerceConversionRate" ], "type": "string" }, "minItems": 1, "type": "array" } }, "required": [ "date_range", "dimensions", "metrics" ], "type": "object" }, "GoogleAnalyticsReportResponse": { "properties": { "count": { "type": "integer" }, "dimensions_order": { "items": { "type": "string" }, "type": "array" }, "metadata": { "$ref": "#/components/schemas/GoogleAnalyticsAccountMetadata" }, "metrics_order": { "items": { "type": "string" }, "type": "array" }, "rows": { "items": { "$ref": "#/components/schemas/GoogleAnalyticsRow" }, "type": "array" }, "totals": { "items": { "type": "string" }, "type": "array" } }, "required": [ "count", "metadata", "metrics_order", "rows" ], "type": "object" }, "GoogleAnalyticsRow": { "properties": { "dimensions": { "items": { "type": "string" }, "type": "array" }, "metrics": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "GoogleAnalyticsValidate": { "properties": { "brand_id": { "description": "Brand ID associated with the GA account", "type": "integer" }, "google_analytics_account_id": { "description": "The ID for the Google Analytics account", "type": "integer" } }, "type": "object" }, "GoogleAnalyticsView": { "properties": { "currency_code": { "description": "GA View reporting currency code", "type": "string" }, "id": { "description": "GA View ID (Universal Analytics only)", "type": "string" }, "name": { "description": "GA View human-readable name (Universal Analytics only)", "type": "string" }, "timezone": { "description": "GA View reporting timezone", "type": "string" } }, "type": "object" }, "HardDeleteMediaBySourceIdRequest": { "properties": { "secret": { "type": "string" }, "source": { "enum": [ "instagram", "INSTAGRAM", "instagram_story", "INSTAGRAM_STORY", "pinterest", "PINTEREST", "facebook", "FACEBOOK", "tiktok", "TIKTOK", "tiktok_ad", "TIKTOK_AD", "twitter", "TWITTER", "youtube", "YOUTUBE", "linkedin", "LINKEDIN", "threads", "THREADS", "snapchat", "SNAPCHAT", "upload", "UPLOAD", "editor", "EDITOR", "ai_generation", "AI_GENERATION" ], "type": "string" }, "source_id": { "default": null, "nullable": true, "type": "string" }, "source_ids": { "default": null, "items": { "type": "string" }, "nullable": true, "type": "array" } }, "required": [ "secret", "source" ], "type": "object" }, "ImageCanvasData": { "properties": { "height": { "type": "number" }, "left": { "type": "number" }, "natural_height": { "type": "number" }, "natural_width": { "type": "number" }, "top": { "type": "number" }, "width": { "type": "number" } }, "type": "object" }, "ImageEditorData": { "properties": { "aspect_ratio": { "description": "Label for the aspect ratio preset the user selected. Not validated or used by the backend.", "type": "string" }, "canvas_data": { "$ref": "#/components/schemas/ImageCanvasData" }, "zoom_value": { "type": "number" } }, "type": "object" }, "ImageMedia": { "properties": { "editor_data": { "allOf": [ { "$ref": "#/components/schemas/ImageEditorData" } ], "description": "Contains UI state for our image editing tools." }, "sizes": { "allOf": [ { "$ref": "#/components/schemas/ImageSizes" } ], "description": "Contains all available image sizes." }, "transforms": { "allOf": [ { "$ref": "#/components/schemas/ImageTransforms" } ], "description": "Transforms that are applied to the image. Currently transforms for images are handled client-side, but this may change in the future." } }, "required": [ "sizes" ], "type": "object" }, "ImageSizes": { "properties": { "medium_square": { "allOf": [ { "$ref": "#/components/schemas/Size" } ], "description": "Medium image. Cropped to a 1:1 aspect ratio.", "readOnly": true }, "original": { "allOf": [ { "$ref": "#/components/schemas/Size" } ], "description": "Original, unmodified image that was uploaded or imported." }, "original_converted": { "allOf": [ { "$ref": "#/components/schemas/Size" } ], "description": "Original image converted to JPEG format. Retains same dimensions as original.", "readOnly": true }, "small": { "allOf": [ { "$ref": "#/components/schemas/Size" } ], "description": "Small image. Retains aspect ratio of original.", "readOnly": true }, "small_square": { "allOf": [ { "$ref": "#/components/schemas/Size" } ], "description": "Small image. Cropped to a 1:1 aspect ratio.", "readOnly": true } }, "required": [ "original" ], "type": "object" }, "ImageTransforms": { "properties": { "crop": { "allOf": [ { "$ref": "#/components/schemas/Crop" } ], "description": "Details of image crop." }, "parent_media_id": { "description": "If the image has been edited with one of our tools (e.g. the image cropper) this will be the ID of the original, unedited media.", "nullable": true, "type": "integer" } }, "type": "object" }, "IndicationFilter": { "properties": { "indications": { "description": "Search for #tag or @mention in searchable captions field.", "items": { "type": "string" }, "type": "array" }, "operator": { "default": "AND", "description": "Search operator.", "enum": [ "AND", "OR" ], "type": "string" } }, "type": "object" }, "InstagramFilters": { "properties": { "caption_keywords": { "$ref": "#/components/schemas/KeywordFilters" }, "features_account": { "description": "Find posts that mention or tag a creator's account handle", "example": "_flapjackie", "type": "string" }, "is_boosted": { "description": "Is Media a boosted Instagram post", "type": "boolean" }, "post_type": { "description": "Instagram post type", "enum": [ "reel", "REEL", "video", "VIDEO", "image", "IMAGE", "carousel", "CAROUSEL" ], "example": "REEL", "type": "string" }, "post_types": { "items": { "description": "Instagram post type", "enum": [ "reel", "REEL", "video", "VIDEO", "image", "IMAGE", "carousel", "CAROUSEL" ], "example": "REEL", "type": "string" }, "type": "array" } }, "type": "object" }, "InstagramStoryFrameFilters": { "properties": { "caption_keywords": { "$ref": "#/components/schemas/KeywordFilters" }, "contain_swipe_up_link": { "description": "If the post contains a swipe up link.", "type": "boolean" } }, "type": "object" }, "InstagramStorySummaryMetrics": { "properties": { "avg_completion_rate": { "description": "Average story frames completion rate in the given time range", "type": "number" }, "avg_completion_rate_views": { "description": "Average story frames completion rate (new) in the given time range", "type": "number" }, "avg_exit_rate": { "description": "Average story frames exit rate in the given time range", "type": "number" }, "avg_exit_rate_views": { "description": "Average story frames exit rate (new) in the given time range", "type": "number" }, "avg_reach": { "description": "Average story frames reach in the given time range", "type": "number" }, "story_frames_count": { "description": "Total story frames in the given time range", "type": "integer" }, "total_impressions": { "description": "Aggregated story frames impressions in the given time range", "type": "integer" }, "total_replies": { "description": "Aggregated story frames replies in the given time range", "type": "integer" }, "total_swipe_ups": { "description": "Aggregated story frames swipe ups in the given time range", "type": "integer" }, "total_views_v2": { "description": "Aggregated story frames views (new) in the given time range", "type": "integer" } }, "type": "object" }, "InstagramStoryTimeseriesMetric": { "properties": { "metrics": { "allOf": [ { "$ref": "#/components/schemas/InstagramStorySummaryMetrics" } ], "description": "Aggregated metrics for the giving timestamp" }, "timestamp": { "description": "Metric aggregated dates", "format": "date", "type": "string" } }, "type": "object" }, "InstagramStoryTimeseriesMetrics": { "properties": { "summary_metrics": { "allOf": [ { "$ref": "#/components/schemas/InstagramStorySummaryMetrics" } ], "description": "Aggregated metrics summary" }, "timeseries_metrics": { "description": "Aggregated metrics grouped by date", "items": { "$ref": "#/components/schemas/InstagramStoryTimeseriesMetric" }, "type": "array" } }, "type": "object" }, "InstagramUGCFilters": { "properties": { "is_riq": { "description": "If true, the user who created this post has been added to the brand as a relationship.", "type": "boolean" }, "post_types": { "items": { "description": "Instagram post type", "enum": [ "reel", "REEL", "video", "VIDEO", "image", "IMAGE", "carousel", "CAROUSEL" ], "example": "REEL", "type": "string" }, "type": "array" }, "ugc_media_type": { "description": "UGC Media Type", "enum": [ "mentioned", "MENTIONED", "tagged", "TAGGED", "all", "ALL", "any", "ANY" ], "example": "MENTIONED", "type": "string" } }, "type": "object" }, "KeywordFilters": { "properties": { "contain": { "items": { "type": "string" }, "type": "array" }, "not_contain": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "LikeShopBenchmarkReportRequest": { "properties": { "end_date": { "description": "The end of the reporting period.", "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(Z|((\\+|-)\\d{2}:\\d{2})))?$", "type": "string" }, "instagram_ids": { "description": "The Instagram account ids to report on.", "items": { "type": "string" }, "type": "array" }, "name": { "description": "The name of the report. This will be included in the CSV file name.", "type": "string" }, "start_date": { "description": "The start of the reporting period.", "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(Z|((\\+|-)\\d{2}:\\d{2})))?$", "type": "string" } }, "required": [ "end_date", "instagram_ids", "name", "start_date" ], "type": "object" }, "LikeShopBenchmarkReportResponse": { "properties": { "file_uri": { "description": "The URI of the resulting report.", "type": "string" } }, "type": "object" }, "LikeshopGalleryCaptureEmailRequest": { "properties": { "email": { "description": "The email of the consumer.", "format": "email", "type": "string" } }, "required": [ "email" ], "type": "object" }, "LikeshopGallerySettings": { "properties": { "banner_image": { "description": "The media id belonging to the banner image.", "nullable": true, "type": "integer" }, "call_to_action": { "description": "The primary CTA shown at the top of LikeShop pages.", "nullable": true, "type": "string" }, "email_capture": { "$ref": "#/components/schemas/EmailSubmissionSettingsRequest" }, "hide_call_to_action": { "description": "Toggle whether the primary CTA is shown or not.", "type": "boolean" }, "pinned_content": { "description": "A list of media ids belonging to pinned content.", "items": { "type": "integer" }, "maxItems": 3, "type": "array" } }, "type": "object" }, "LinkedinFilters": { "properties": { "caption_keywords": { "$ref": "#/components/schemas/KeywordFilters" }, "post_types": { "description": "LinkedIn post types to filter on", "example": [ "IMAGE", "VIDEO" ], "items": { "enum": [ "VIDEO", "TEXT", "MULTI_IMAGE", "DOCUMENT", "IMAGE", "LINK" ], "type": "string" }, "type": "array" } }, "type": "object" }, "LinksSummary": { "properties": { "most_recent_link": { "$ref": "#/components/schemas/MostRecentLink" }, "total_clicks": { "type": "integer" }, "total_num_of_links": { "type": "integer" } }, "required": [ "most_recent_link", "total_clicks", "total_num_of_links" ], "type": "object" }, "ListAiAlternativeAdsRequest": { "properties": { "source_ad_ids": { "items": { "type": "string" }, "type": "array" } }, "required": [ "source_ad_ids" ], "type": "object" }, "ListAiAlternativeAdsResponse": { "properties": { "data": { "items": { "$ref": "#/components/schemas/AiAlternativeAds" }, "type": "array" } }, "type": "object" }, "ListAiAlternativeMediaResponse": { "properties": { "data": { "items": { "$ref": "#/components/schemas/AiAlternativeMedia" }, "type": "array" }, "paging": { "$ref": "#/components/schemas/PagingData" } }, "type": "object" }, "Media": { "properties": { "created_at": { "format": "date-time", "type": "string" }, "duration": {}, "frame_rate": {}, "id": { "type": "integer" }, "image_sizes": {}, "media_group": { "nullable": true, "type": "integer" }, "notes": { "readOnly": true, "type": "string" }, "original_height": { "nullable": true, "type": "integer" }, "original_width": { "nullable": true, "type": "integer" }, "predictions": { "readOnly": true }, "source": { "enum": [ "instagram", "INSTAGRAM", "instagram_story", "INSTAGRAM_STORY", "pinterest", "PINTEREST", "facebook", "FACEBOOK", "tiktok", "TIKTOK", "tiktok_ad", "TIKTOK_AD", "twitter", "TWITTER", "youtube", "YOUTUBE", "linkedin", "LINKEDIN", "threads", "THREADS", "snapchat", "SNAPCHAT", "upload", "UPLOAD", "editor", "EDITOR", "ai_generation", "AI_GENERATION" ], "type": "string" }, "source_created_at": { "default": "2026-04-10T14:57:59.977494", "format": "date-time", "type": "string" }, "source_data": { "readOnly": true }, "source_id": { "type": "string" }, "tags": { "items": { "$ref": "#/components/schemas/MediaTag" }, "type": "array" }, "thumbnail_url": { "type": "string", "writeOnly": true }, "type": { "readOnly": true, "type": "string" }, "updated_at": { "format": "date-time", "type": "string" }, "url": { "type": "string", "writeOnly": true }, "urls": {}, "video_sizes": {} }, "required": [ "source", "source_id" ], "type": "object" }, "MediaFilters": { "properties": { "brand_media_types": { "items": { "description": "Brand Media Type", "example": "INSTAGRAM_OWNED", "type": "string", "enum": [ "INSTAGRAM_OWNED", "INSTAGRAM_UGC", "INSTAGRAM_OTHER", "INSTAGRAM_OWNED_IGTV", "INSTAGRAM_UGC_IGTV", "INSTAGRAM_OTHER_IGTV", "INSTAGRAM_STORY", "INSTAGRAM_STORY_UGC", "PINTEREST_OWNED", "FACEBOOK_OWNED", "FACEBOOK_LINK", "FACEBOOK_TEXT_LINK", "FACEBOOK_TEXT", "TWITTER_OWNED", "TWITTER_OWNED_LINK", "TWITTER_OWNED_TEXT", "TIKTOK_OWNED", "YOUTUBE_OWNED", "UPLOADED" ] }, "type": "array" }, "source_created_at": { "$ref": "#/components/schemas/DateRangeFilters" }, "instagram": { "$ref": "#/components/schemas/InstagramFilters" }, "instagram_story_frame": { "$ref": "#/components/schemas/InstagramStoryFrameFilters" }, "instagram_ugc": { "$ref": "#/components/schemas/InstagramUGCFilters" }, "instagram_story_ugc": { "$ref": "#/components/schemas/InstagramUGCFilters" }, "facebook": { "$ref": "#/components/schemas/FacebookFilters" }, "tiktok": { "$ref": "#/components/schemas/TikTokFilters" }, "tiktok_ugc": { "$ref": "#/components/schemas/TikTokUGCFilters" }, "tiktok_ad": { "$ref": "#/components/schemas/TikTokAdFilters" }, "pinterest": { "$ref": "#/components/schemas/PinterestFilters" }, "twitter": { "$ref": "#/components/schemas/TwitterFilters" }, "youtube": { "$ref": "#/components/schemas/YouTubeFilters" }, "linkedin": { "$ref": "#/components/schemas/LinkedinFilters" }, "threads": { "$ref": "#/components/schemas/ThreadsFilters" }, "snapchat": { "$ref": "#/components/schemas/SnapchatFilters" }, "content_tags": { "description": "content tag names that brand media can be tagged with", "example": [ "Tag 1", "Tag 2" ], "items": { "type": "string" }, "type": "array" }, "content_tag_match_type": { "description": "Indicates if media should contain ALL supplied content tag IDs, or ANY supplied content tag IDs", "enum": [ "ALL", "ANY" ], "example": "ANY", "type": "string" }, "ai_generated": { "$ref": "#/components/schemas/AIGeneratedFilters" }, "boards": { "description": "Array of Board IDs to filter media by", "example": [ 1234, 4567 ], "items": { "type": "integer" }, "type": "array" }, "brand_ids": { "description": "List of brand IDs to check for media", "example": [ 144, 1 ], "items": { "type": "integer" }, "type": "array" }, "brand_media_status": { "description": "Filter by brand media status (e.g. HIDDEN for hidden UGC). When not set, defaults to PROCESSED and NEW (excludes hidden).", "enum": [ "PROCESSED", "HIDDEN", "NEW", "NEW_NO_ANNOTATIONS", "VIDEO_PROCESSING" ], "type": "string" }, "campaign_ids": { "description": "Array of campaign IDs to filter creators in source media", "example": [ 1234, 4567 ], "items": { "type": "integer" }, "type": "array" }, "campaigns": { "description": "Array of campaign IDs to filter media by", "example": [ 123, 456 ], "items": { "type": "integer" }, "type": "array" }, "campaigns_post_type": { "description": "Post Type to support multi channel media type filtering", "enum": [ "VIDEO", "POST" ], "example": "VIDEO", "type": "string" }, "caption_is_negative": { "description": "Is the post caption labeled as negative.", "type": "boolean" }, "caption_is_neutral": { "description": "Is the post caption labeled as neutral.", "type": "boolean" }, "caption_is_positive": { "description": "Is the post caption labeled as positive.", "type": "boolean" }, "caption_is_question": { "description": "Is the post a labeled as a question.", "type": "boolean" }, "color": { "description": "Major colour in the media", "example": "red", "type": "string" }, "colors": { "description": "Major colours in the media", "items": { "description": "Major colour in the media", "enum": [ "red", "orange", "yellow", "green", "cyan", "blue", "purple", "pink", "brown", "black", "gray", "white" ], "example": "red", "type": "string" }, "type": "array" }, "comments_are_negative": { "description": "Are the post comments labeled as negative.", "type": "boolean" }, "comments_are_neutral": { "description": "Are the post comments labeled as neutral.", "type": "boolean" }, "comments_are_positive": { "description": "Are the post comments labeled as positive.", "type": "boolean" }, "content_rights_requested_by": { "description": "Filter by who requested content rights (Dash user_id)", "example": "12345", "type": "string" }, "content_rights_requested_date": { "allOf": [ { "$ref": "#/components/schemas/DateRangeFilters" } ], "description": "Filter by date range when content rights were requested" }, "content_rights_type": { "description": "Filter by content rights status values", "example": [ "APPROVED", "REQUESTED" ], "items": { "enum": [ "APPROVED", "NOT_REQUESTED", "REQUESTED", "LAPSED", "FAILED", "EXPIRED" ], "type": "string" }, "type": "array" }, "excluded_channels": { "description": "Social media channels to exclude from the most viewed videos query.", "items": { "enum": [ "FACEBOOK", "INSTAGRAM", "TWITTER", "PINTEREST", "TIKTOK", "YOUTUBE", "LINKEDIN", "THREADS", "COMPLIANCE", "SNAPCHAT" ], "type": "string" }, "type": "array" }, "excluded_media_ids": { "description": "Array of media IDs to exclude from results", "example": [ 1234, 4567 ], "items": { "type": "integer" }, "type": "array" }, "galleries": { "description": "Array of gallery IDs to filter media by", "example": [ 1234, 4567 ], "items": { "type": "integer" }, "type": "array" }, "image_data": { "description": "JPEG Image as base64", "example": "data:image/jpeg;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7", "type": "string" }, "include_disconnected_story_ugc": { "description": "If true, results will include UGC story media that was imported via DM and more than 24 hours old. For policy reasons, we only want these included in specific parts of the platform.", "type": "boolean" }, "indication_filter": { "$ref": "#/components/schemas/IndicationFilter" }, "media_id": { "description": "id of media used to perform visual search", "type": "integer" }, "media_types": { "items": { "description": "Media Type", "example": "VIDEO", "type": "string" }, "type": "array" }, "prediction": { "$ref": "#/components/schemas/PredictionFilters" }, "ratio": { "description": "Shape of media", "example": "SQUARE", "type": "string" }, "ratios": { "description": "List of shapes of media", "items": { "description": "Shape of media", "enum": [ "SQUARE", "LANDSCAPE", "PORTRAIT" ], "example": "SQUARE", "type": "string" }, "type": "array" }, "rights_approved": { "description": "Whether brand has acquired content right", "type": "boolean" }, "scope_platform_filters": { "description": "When passing multiple brand_media_types and platform specific filters such as YouTubeFilters, scope the platform specific filters to the relvant platform only. If this is false, all platform specific filters will apply to all platforms, so no results will be returned.", "type": "boolean" }, "search_term": { "description": "Term to search for in the media", "type": "string" }, "search_terms": { "description": "Search in terms", "type": "boolean" }, "size": { "description": "Minimum resolution of media", "example": "800x600", "type": "string" }, "source_account_ids": { "description": "account ids of the source media", "example": [ "123456789", "987654321" ], "items": { "type": "string" }, "type": "array" }, "source_ids": { "description": "Array of source ids to return", "example": [ "1234", "4567" ], "items": { "type": "string" }, "type": "array" }, "uploads": { "$ref": "#/components/schemas/UploadFilters" } }, "type": "object" }, "MediaPredictionFile": { "properties": { "id": { "type": "string" }, "url": { "type": "string" } }, "type": "object" }, "MediaPreview": { "properties": { "image_url": { "type": "string" } }, "required": [ "image_url" ], "type": "object" }, "MediaProduct": { "properties": { "bounding_box": { "nullable": true }, "created_at": { "format": "date-time", "type": "string" }, "deleted": { "nullable": true, "type": "integer" }, "deleted_at": { "format": "date-time", "nullable": true, "type": "string" }, "description": { "type": "string" }, "hide_in_widget": { "nullable": true, "type": "integer" }, "id": { "type": "integer" }, "image_url": { "type": "string" }, "product": { "$ref": "#/components/schemas/Product" }, "product_groups": { "items": { "$ref": "#/components/schemas/ProductGroup" }, "type": "array" }, "product_id": { "type": "integer" }, "source_id": { "type": "string" }, "title": { "type": "string" }, "updated_at": { "format": "date-time", "type": "string" }, "url": { "type": "string" }, "x": { "type": "number" }, "y": { "type": "number" } }, "type": "object" }, "MediaSearchBody": { "properties": { "content_tags": { "description": "content tag names that brand media can be tagged with", "example": [ "Tag 1", "Tag 2" ], "items": { "type": "string" }, "type": "array" }, "image_data": { "description": "Image data when searching by image.", "type": "string" } }, "type": "object" }, "MediaSearchResult": { "properties": { "brand_media_id": { "type": "integer" }, "brand_type": { "type": "string" }, "can_publish_within": { "allOf": [ { "$ref": "#/components/schemas/DateTimeRange" } ], "readOnly": true }, "caption_question": { "allOf": [ { "$ref": "#/components/schemas/SentimentQuestion" } ], "readOnly": true }, "caption_sentiment": { "allOf": [ { "$ref": "#/components/schemas/Sentiment" } ], "readOnly": true }, "comment_sentiment": { "allOf": [ { "$ref": "#/components/schemas/Sentiment" } ], "readOnly": true }, "created_at": { "type": "string" }, "duration": {}, "height": { "type": "integer" }, "id": { "type": "integer" }, "insights": { "description": "Source media data", "readOnly": true, "type": "object" }, "media_group": { "type": "integer" }, "media_type": { "type": "string" }, "performance": { "type": "number" }, "predictions": { "default": null, "nullable": true }, "reach": { "nullable": true, "type": "integer" }, "sort": { "type": "string" }, "source": { "type": "string" }, "source_created_at": { "type": "string" }, "source_id": { "type": "string" }, "urls": {}, "visual_features": { "readOnly": true, "type": "string" }, "width": { "type": "integer" } }, "type": "object" }, "MediaTag": { "properties": { "brand_id": { "type": "integer" }, "created_at": { "format": "date-time", "type": "string" }, "id": { "type": "integer" }, "name": { "maxLength": 20, "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "brand_id", "name" ], "type": "object" }, "MediaUGCList": { "properties": { "data": { "items": { "$ref": "#/components/schemas/MediaV2" }, "type": "array" }, "paging": { "$ref": "#/components/schemas/PagingData" } }, "type": "object" }, "MediaV2": { "properties": { "brand_id": { "readOnly": true, "type": "integer" }, "brand_media_id": { "readOnly": true, "type": "integer" }, "brand_media_status": { "description": "Status of the brand media (e.g. PROCESSED, HIDDEN, NEW).", "readOnly": true, "type": "string" }, "callback_socket_id": { "description": "ID of WebSocket to notify when media conversion is complete.", "type": "string" }, "can_publish_within": { "allOf": [ { "$ref": "#/components/schemas/DateTimeRange" } ], "description": "Media is only allowed to be published within this range of dates.", "readOnly": true }, "caption_question": { "allOf": [ { "$ref": "#/components/schemas/SentimentQuestion" } ], "description": "Whether the caption of this media item includes a question.", "readOnly": true }, "caption_sentiment": { "allOf": [ { "$ref": "#/components/schemas/Sentiment" } ], "description": "Sentiment as determined by the caption of this media item.", "readOnly": true }, "collections": { "description": "Collections that the media belong to.", "readOnly": true, "type": "object" }, "comment_sentiment": { "allOf": [ { "$ref": "#/components/schemas/Sentiment" } ], "description": "Sentiment as determined by the aggregated comments on this media item.", "readOnly": true }, "community_engagement": { "description": "Media engagement for community overview", "readOnly": true, "type": "integer" }, "content_rights_expiry_date": { "description": "Expiry date of the content rights.", "format": "date-time", "readOnly": true, "type": "string" }, "content_rights_requested_by": { "description": "User ID of the person who requested content rights.", "readOnly": true, "type": "string" }, "content_rights_requested_date": { "description": "Date when the content rights were requested.", "format": "date-time", "readOnly": true, "type": "string" }, "content_rights_type": { "description": "Content rights status of the media.", "enum": [ "APPROVED", "NOT_REQUESTED", "REQUESTED", "LAPSED", "FAILED", "EXPIRED" ], "readOnly": true, "type": "string" }, "content_tags": { "description": "content tag names that brand media can be tagged with", "example": [ "Tag 1", "Tag 2" ], "items": {}, "type": "array" }, "created_at": { "description": "An ISO-8601 formatted timestamp of when the object was created.", "format": "date-time", "readOnly": true, "type": "string" }, "creator": { "allOf": [ { "$ref": "#/components/schemas/Creator" } ], "description": "Creator info for the media", "readOnly": true }, "custom_metrics": { "items": { "allOf": [ { "$ref": "#/components/schemas/CustomMetric" } ], "readOnly": true }, "type": "array" }, "facebook": { "description": "Facebook source data.", "readOnly": true, "type": "object" }, "id": { "description": "The object's ID.", "readOnly": true, "type": "integer" }, "image": { "allOf": [ { "$ref": "#/components/schemas/ImageMedia" } ], "description": "Data if type is `IMAGE`." }, "instagram": { "description": "Instagram source data.", "readOnly": true, "type": "object" }, "instagram_ads": { "description": "Instagram ads source data.", "readOnly": true, "type": "object" }, "instagram_story": { "description": "Instagram story source data.", "readOnly": true, "type": "object" }, "instagram_story_frame": { "description": "Instagram story frame source data.", "readOnly": true, "type": "object" }, "instagram_user": { "description": "Instagram User source data.", "readOnly": true, "type": "object" }, "likeshop": { "allOf": [ { "$ref": "#/components/schemas/GalleryLikeshopStat" } ], "description": "Likeshop Stats." }, "linkedin": { "description": "LinkedIn source data.", "readOnly": true, "type": "object" }, "media_group": { "description": "Media group ID.", "readOnly": true, "type": "integer" }, "meta": { "allOf": [ { "$ref": "#/components/schemas/MediaV2Meta" } ], "description": "Metadata describing this media item." }, "pinterest": { "description": "Pinterest source data.", "readOnly": true, "type": "object" }, "predictions": { "allOf": [ { "$ref": "#/components/schemas/Predictions" } ], "description": "Contains vision predictions for this media. Only returned if `include` query param contains \"predictions\".", "readOnly": true }, "snapchat": { "description": "Snapchat source data.", "readOnly": true, "type": "object" }, "source": { "description": "Source of media.", "enum": [ "INSTAGRAM", "INSTAGRAM_STORY", "PINTEREST", "FACEBOOK", "TIKTOK", "TIKTOK_AD", "TWITTER", "YOUTUBE", "LINKEDIN", "THREADS", "SNAPCHAT", "UPLOAD", "EDITOR", "AI_GENERATION", "FACEBOOK_ADS", "FACEBOOK_LINK", "FACEBOOK_TEXT", "FACEBOOK_TEXT_LINK", "TWITTER_LINK", "TWITTER_TEXT" ], "type": "string" }, "source_account_id": { "description": "The native ID of the account that created this post, if applicable.", "readOnly": true, "type": "string" }, "source_created_at": { "description": "An ISO-8601 formatted timestamp of when the source object was created.", "format": "date-time", "type": "string" }, "source_id": { "description": "Source ID of media.", "readOnly": true, "type": "string" }, "source_type": { "description": "Type of source.", "enum": [ "UGC", "OWNED", "OTHER" ], "type": "string" }, "threads": { "description": "Threads source data.", "readOnly": true, "type": "object" }, "tiktok": { "description": "TikTok source data.", "readOnly": true, "type": "object" }, "tiktok_ad": { "description": "TikTok Ad source data.", "readOnly": true, "type": "object" }, "twitter": { "description": "Twitter source data.", "readOnly": true, "type": "object" }, "type": { "description": "Type of media.", "enum": [ "IMAGE", "VIDEO", "CAROUSEL", "REEL" ], "type": "string" }, "updated_at": { "description": "An ISO-8601 formatted timestamp of when the object was last updated.", "format": "date-time", "readOnly": true, "type": "string" }, "variants": { "description": "Variants of media: TEXT, LINK", "items": { "enum": [ "TEXT", "LINK" ], "type": "string" }, "type": "array" }, "video": { "allOf": [ { "$ref": "#/components/schemas/VideoMedia" } ], "description": "Data if type is `VIDEO`." }, "video_predictions": { "allOf": [ { "$ref": "#/components/schemas/VideoPredictions" } ], "description": "Contains vision predictions for video media, which is a list of prediction values by frame equidistant to the length of the video", "readOnly": true }, "video_predictions_interval_sec": { "description": "Time interval for sampled video predictions", "type": "number" }, "video_suggested_thumbnail_list": { "items": { "allOf": [ { "$ref": "#/components/schemas/VideoSuggestedThumbnail" } ], "description": "List of suggested thumbnails for higher engagement", "readOnly": true }, "type": "array" }, "visual_features": { "description": "Visual features string of this media", "readOnly": true, "type": "string" }, "youtube": { "description": "YouTube source data", "readOnly": true, "type": "object" } }, "required": [ "source", "type" ], "type": "object" }, "MediaV2CSVRequest": { "properties": { "file_name_prefix": { "description": "Prefix of the file name.", "type": "string" }, "filters": { "$ref": "#/components/schemas/MediaFilters" }, "limit": { "description": "Limit of the number of media to return.", "type": "integer" }, "socket_id": { "description": "Socket id.", "type": "string" }, "sort": { "description": "Media filter order.\"-\" means in a desc order.", "example": "-DATE", "type": "string" }, "sort_fields": { "default": [ "-DATE" ], "description": "List of sort orders to be applied to search.", "example": [ "-DATE", "-FACEBOOK_TOTAL_ENGAGEMENTS" ], "items": { "description": "Media filter order. (Prefixing an option with `-` sorts in a descending order for this field.)", "example": "-DATE", "type": "string" }, "type": "array" }, "source": { "description": "Source of media.", "enum": [ "FACEBOOK", "FACEBOOK_TOP_POSTS", "INSTAGRAM", "INSTAGRAM_LIKESHOP", "INSTAGRAM_LIKESHOP_PRODUCTS", "INSTAGRAM_STORY", "INSTAGRAM_UGC", "INSTAGRAM_UGC_RIQ", "LINKEDIN", "TIKTOK", "TIKTOK_LIKESHOP", "TIKTOK_LIKESHOP_PRODUCTS", "TWITTER", "YOUTUBE", "THREADS", "PINTEREST", "SNAPCHAT" ], "type": "string" } }, "required": [ "socket_id", "source" ], "type": "object" }, "MediaV2List": { "properties": { "data": { "description": "List of MediaV2 Object.", "items": { "$ref": "#/components/schemas/MediaV2" }, "type": "array" }, "paging": { "allOf": [ { "$ref": "#/components/schemas/PagingData" } ], "description": "Paging object." } }, "type": "object" }, "MediaV2Meta": { "properties": { "filename": { "description": "The name of the uploaded file.", "type": "string" }, "last_modified_at": { "description": "The most recent timestamp at which this media item was modified.", "type": "string" }, "uploaded_by": { "description": "DH user ID of the person who uploaded the media.", "type": "integer" } }, "type": "object" }, "MostRecentLink": { "properties": { "bitlink_url": { "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "link_title": { "type": "string" } }, "required": [ "bitlink_url", "created_at", "link_title" ], "type": "object" }, "MultiBrandSearchFilters": { "properties": { "ai_generated": { "$ref": "#/components/schemas/AIGeneratedFilters" }, "boards": { "description": "Array of Board IDs to filter media by", "example": [ 1234, 4567 ], "items": { "type": "integer" }, "type": "array" }, "brand_ids": { "description": "Brand IDs to filter by. Example: [144, 1]", "items": { "type": "integer" }, "type": "array" }, "brand_media_status": { "description": "Filter by brand media status (e.g. HIDDEN for hidden UGC). When not set, defaults to PROCESSED and NEW (excludes hidden).", "enum": [ "PROCESSED", "HIDDEN", "NEW", "NEW_NO_ANNOTATIONS", "VIDEO_PROCESSING" ], "type": "string" }, "brand_media_types": { "items": { "description": "Brand Media Type", "example": "INSTAGRAM_OWNED", "type": "string" }, "type": "array" }, "campaign_ids": { "description": "Array of campaign IDs to filter creators in source media", "example": [ 1234, 4567 ], "items": { "type": "integer" }, "type": "array" }, "campaigns": { "description": "Array of campaign IDs to filter media by", "example": [ 123, 456 ], "items": { "type": "integer" }, "type": "array" }, "campaigns_post_type": { "description": "Post Type to support multi channel media type filtering", "enum": [ "VIDEO", "POST" ], "example": "VIDEO", "type": "string" }, "caption_is_negative": { "description": "Is the post caption labeled as negative.", "type": "boolean" }, "caption_is_neutral": { "description": "Is the post caption labeled as neutral.", "type": "boolean" }, "caption_is_positive": { "description": "Is the post caption labeled as positive.", "type": "boolean" }, "caption_is_question": { "description": "Is the post a labeled as a question.", "type": "boolean" }, "color": { "description": "Major colour in the media", "example": "red", "type": "string" }, "colors": { "description": "Major colours in the media", "items": { "description": "Major colour in the media", "enum": [ "red", "orange", "yellow", "green", "cyan", "blue", "purple", "pink", "brown", "black", "gray", "white" ], "example": "red", "type": "string" }, "type": "array" }, "comments_are_negative": { "description": "Are the post comments labeled as negative.", "type": "boolean" }, "comments_are_neutral": { "description": "Are the post comments labeled as neutral.", "type": "boolean" }, "comments_are_positive": { "description": "Are the post comments labeled as positive.", "type": "boolean" }, "content_rights_requested_by": { "description": "Filter by who requested content rights (Dash user_id)", "example": "12345", "type": "string" }, "content_rights_requested_date": { "allOf": [ { "$ref": "#/components/schemas/DateRangeFilters" } ], "description": "Filter by date range when content rights were requested" }, "content_rights_type": { "description": "Filter by content rights status values", "example": [ "APPROVED", "REQUESTED" ], "items": { "enum": [ "APPROVED", "NOT_REQUESTED", "REQUESTED", "LAPSED", "FAILED", "EXPIRED" ], "type": "string" }, "type": "array" }, "content_tag_match_type": { "description": "Indicates if media should contain ALL supplied content tag IDs, or ANY supplied content tag IDs", "enum": [ "ALL", "ANY" ], "example": "ANY", "type": "string" }, "content_tags": { "description": "content tag names that brand media can be tagged with", "example": [ "Tag 1", "Tag 2" ], "items": { "type": "string" }, "type": "array" }, "excluded_channels": { "description": "Social media channels to exclude from the most viewed videos query.", "items": { "enum": [ "FACEBOOK", "INSTAGRAM", "TWITTER", "PINTEREST", "TIKTOK", "YOUTUBE", "LINKEDIN", "THREADS", "COMPLIANCE", "SNAPCHAT" ], "type": "string" }, "type": "array" }, "excluded_media_ids": { "description": "Array of media IDs to exclude from results", "example": [ 1234, 4567 ], "items": { "type": "integer" }, "type": "array" }, "facebook": { "$ref": "#/components/schemas/FacebookFilters" }, "galleries": { "description": "Array of gallery IDs to filter media by", "example": [ 1234, 4567 ], "items": { "type": "integer" }, "type": "array" }, "image_data": { "description": "JPEG Image as base64", "example": "data:image/jpeg;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7", "type": "string" }, "include_disconnected_story_ugc": { "description": "If true, results will include UGC story media that was imported via DM and more than 24 hours old. For policy reasons, we only want these included in specific parts of the platform.", "type": "boolean" }, "indication_filter": { "$ref": "#/components/schemas/IndicationFilter" }, "instagram": { "$ref": "#/components/schemas/InstagramFilters" }, "instagram_story_frame": { "$ref": "#/components/schemas/InstagramStoryFrameFilters" }, "instagram_story_ugc": { "$ref": "#/components/schemas/InstagramUGCFilters" }, "instagram_ugc": { "$ref": "#/components/schemas/InstagramUGCFilters" }, "linkedin": { "$ref": "#/components/schemas/LinkedinFilters" }, "media_ids": { "description": "List of media IDs to query", "items": { "type": "integer" }, "type": "array" }, "media_types": { "items": { "description": "Media Type", "example": "VIDEO", "type": "string" }, "type": "array" }, "pinterest": { "$ref": "#/components/schemas/PinterestFilters" }, "prediction": { "$ref": "#/components/schemas/PredictionFilters" }, "ratio": { "description": "Shape of media", "example": "SQUARE", "type": "string" }, "ratios": { "description": "List of shapes of media", "items": { "description": "Shape of media", "enum": [ "SQUARE", "LANDSCAPE", "PORTRAIT" ], "example": "SQUARE", "type": "string" }, "type": "array" }, "rights_approved": { "description": "Whether brand has acquired content right", "type": "boolean" }, "scope_platform_filters": { "description": "When passing multiple brand_media_types and platform specific filters such as YouTubeFilters, scope the platform specific filters to the relvant platform only. If this is false, all platform specific filters will apply to all platforms, so no results will be returned.", "type": "boolean" }, "search_term": { "description": "Term to search for in the media", "type": "string" }, "search_terms": { "description": "Search in terms", "type": "boolean" }, "size": { "description": "Minimum resolution of media", "example": "800x600", "type": "string" }, "snapchat": { "$ref": "#/components/schemas/SnapchatFilters" }, "source_account_ids": { "description": "account ids of the source media", "example": [ "123456789", "987654321" ], "items": { "type": "string" }, "type": "array" }, "source_created_at": { "$ref": "#/components/schemas/DateRangeFilters" }, "source_ids": { "description": "Array of source ids to return", "example": [ "1234", "4567" ], "items": { "type": "string" }, "type": "array" }, "threads": { "$ref": "#/components/schemas/ThreadsFilters" }, "tiktok": { "$ref": "#/components/schemas/TikTokFilters" }, "tiktok_ad": { "$ref": "#/components/schemas/TikTokAdFilters" }, "tiktok_ugc": { "$ref": "#/components/schemas/TikTokUGCFilters" }, "twitter": { "$ref": "#/components/schemas/TwitterFilters" }, "uploads": { "$ref": "#/components/schemas/UploadFilters" }, "youtube": { "$ref": "#/components/schemas/YouTubeFilters" } }, "required": [ "brand_ids" ], "type": "object" }, "OwnedSummaryMetricItem": { "properties": { "aggregation": { "description": "The aggregation method for custom metrics (required for custom_metrics source)", "enum": [ "SUM", "AVERAGE" ], "type": "string" }, "goal": { "default": null, "description": "The goal value for this metric", "nullable": true, "type": "number" }, "id": { "description": "The ID of the metric. Required for custom metrics.", "type": "integer" }, "metric": { "description": "The name of the metric. Required for non-custom metrics.", "type": "string" }, "source": { "description": "The source of the metric data. Must be one of campaign_stats, custom_metrics", "enum": [ "campaign_stats", "custom_metrics" ], "type": "string" } }, "required": [ "source" ], "type": "object" }, "PagingData": { "properties": { "count": { "description": "Number of records in the current page.", "type": "integer" }, "next": { "description": "URL to the next page of data.", "format": "url", "nullable": true, "type": "string" }, "previous": { "description": "URL to the previous page of data.", "format": "url", "nullable": true, "type": "string" } }, "type": "object" }, "PinterestFilters": { "properties": { "is_video": { "description": "Is pin a video", "example": true, "type": "boolean" }, "pin_board_privacy": { "description": "Is pin protected", "example": "public", "type": "string" }, "post_types": { "items": { "description": "Post Type", "enum": [ "video", "VIDEO", "image", "IMAGE", "photo", "PHOTO", "carousel", "CAROUSEL" ], "example": "video", "type": "string" }, "type": "array" } }, "type": "object" }, "PredictionFilters": { "properties": { "max": { "description": "Upper bound of media prediction between [0, 1]", "example": 0.85, "type": "number" }, "min": { "description": "Lower bound of media prediction between [0, 1]", "example": 0.5, "type": "number" } }, "type": "object" }, "Predictions": { "properties": { "ad_engagement": { "description": "Vision predicted ad engagement rating for media.", "type": "number" }, "conversions": { "description": "Vision predicted conversion rating for media.", "type": "number" }, "engagement": { "description": "Vision predicted engagement rating for media.", "type": "number" }, "link_clicks": { "description": "Vision predicted link click engagement rating for media.", "type": "number" } }, "type": "object" }, "PredictionsV2": { "properties": { "engagement": { "description": "Vision predicted engagement rating for media.", "type": "number" } }, "type": "object" }, "Product": { "properties": { "archived": { "type": "boolean" }, "availability": { "type": "string" }, "brand_id": { "type": "integer" }, "category": { "maxLength": 512, "nullable": true, "type": "string" }, "clicks": { "readOnly": true, "type": "integer" }, "created_at": { "format": "date-time", "nullable": true, "type": "string" }, "currency_code": { "maxLength": 3, "nullable": true, "type": "string" }, "description": { "nullable": true, "type": "string" }, "google_source_id": { "maxLength": 70, "nullable": true, "type": "string" }, "has_edits": { "type": "integer" }, "id": { "type": "integer" }, "image_url": { "maxLength": 750, "nullable": true, "type": "string" }, "is_disabled": { "type": "integer" }, "is_in_stock": { "enum": [ "in stock", "IN STOCK", "out of stock", "OUT OF STOCK", "preorder", "PREORDER", "available for order", "AVAILABLE FOR ORDER", "discontinued", "DISCONTINUED" ], "type": "string" }, "last_updated_by_product_feed_at": { "format": "date-time", "nullable": true, "type": "string" }, "original_url": { "maxLength": 750, "nullable": true, "type": "string" }, "price": { "maxLength": 50, "nullable": true, "type": "string" }, "product_feed": { "$ref": "#/components/schemas/ProductFeed" }, "product_overrides": { "items": { "$ref": "#/components/schemas/ProductOverride" }, "type": "array" }, "source_group_id": { "maxLength": 70, "nullable": true, "type": "string" }, "source_id": { "maxLength": 70, "nullable": true, "type": "string" }, "status": { "maxLength": 10, "nullable": true, "type": "string" }, "title": { "maxLength": 512, "type": "string" }, "updated_at": { "format": "date-time", "type": "string" }, "url": { "maxLength": 750, "type": "string" } }, "required": [ "brand_id", "title", "url" ], "type": "object" }, "Product1": { "properties": { "archived": { "type": "boolean" }, "availability": { "type": "string" }, "brand_id": { "type": "integer" }, "category": { "maxLength": 512, "nullable": true, "type": "string" }, "created_at": { "format": "date-time", "nullable": true, "type": "string" }, "currency_code": { "maxLength": 3, "nullable": true, "type": "string" }, "description": { "nullable": true, "type": "string" }, "google_source_id": { "maxLength": 70, "nullable": true, "type": "string" }, "has_edits": { "type": "integer" }, "id": { "type": "integer" }, "image_url": { "maxLength": 750, "nullable": true, "type": "string" }, "is_disabled": { "type": "integer" }, "is_in_stock": { "enum": [ "in stock", "IN STOCK", "out of stock", "OUT OF STOCK", "preorder", "PREORDER", "available for order", "AVAILABLE FOR ORDER", "discontinued", "DISCONTINUED" ], "type": "string" }, "last_updated_by_product_feed_at": { "format": "date-time", "nullable": true, "type": "string" }, "original_url": { "maxLength": 750, "nullable": true, "type": "string" }, "price": { "maxLength": 50, "nullable": true, "type": "string" }, "product_overrides": { "items": { "$ref": "#/components/schemas/ProductOverride" }, "type": "array" }, "source_group_id": { "maxLength": 70, "nullable": true, "type": "string" }, "source_id": { "maxLength": 70, "nullable": true, "type": "string" }, "status": { "maxLength": 10, "nullable": true, "type": "string" }, "title": { "maxLength": 512, "type": "string" }, "updated_at": { "format": "date-time", "type": "string" }, "url": { "maxLength": 750, "type": "string" } }, "required": [ "brand_id", "title", "url" ], "type": "object" }, "ProductCatalog": { "properties": { "brand_id": { "type": "integer" }, "created_at": { "format": "date-time", "type": "string" }, "deleted": { "nullable": true, "type": "integer" }, "deleted_at": { "format": "date-time", "nullable": true, "type": "string" }, "id": { "minimum": 0, "readOnly": true, "type": "integer" }, "name": { "type": "string" }, "source": { "enum": [ "facebook", "FACEBOOK" ], "minLength": 1, "type": "string" }, "source_id": { "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "brand_id", "name", "source", "source_id" ], "type": "object" }, "ProductFeed": { "properties": { "archived": { "type": "boolean" }, "brand_id": { "type": "integer" }, "checksum": { "maxLength": 32, "nullable": true, "type": "string" }, "checksum_created_at": { "format": "date-time", "nullable": true, "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "custom_field_mapping": { "nullable": true }, "delimiter": { "maxLength": 5, "nullable": true, "type": "string" }, "encoding": { "maxLength": 30, "nullable": true, "type": "string" }, "feed_type": { "default": null, "enum": [ "xml", "XML", "xsv", "XSV", "product_catalog", "PRODUCT_CATALOG", "override", "OVERRIDE", null ], "minLength": 1, "nullable": true, "type": "string" }, "id": { "minimum": 0, "readOnly": true, "type": "integer" }, "last_update_started_at": { "format": "date-time", "nullable": true, "type": "string" }, "last_updated": { "format": "date-time", "nullable": true, "type": "string" }, "out_of_stock_threshold": { "nullable": true, "type": "integer" }, "override": { "maxLength": 5, "nullable": true, "type": "string" }, "product_catalog": { "$ref": "#/components/schemas/ProductCatalog" }, "status": { "enum": [ "init", "INIT", "connected", "CONNECTED", "updating", "UPDATING", "error", "ERROR", "not_found", "NOT_FOUND" ], "minLength": 1, "type": "string" }, "unique_product_key": { "maxLength": 30, "type": "string" }, "updated_at": { "format": "date-time", "type": "string" }, "url": { "maxLength": 512, "minLength": 1, "type": "string" }, "use_private_key": { "nullable": true, "type": "boolean" }, "xsv_dialect_hints": { "nullable": true } }, "required": [ "brand_id", "url" ], "type": "object" }, "ProductFeedArchiveRequest": { "properties": { "archived": { "type": "boolean" }, "notification_socket_id": { "nullable": true, "type": "string" } }, "required": [ "archived" ], "type": "object" }, "ProductFeedCreateRequest": { "properties": { "product_catalog_id": { "default": null, "nullable": true, "type": "integer" }, "url": { "default": null, "maxLength": 512, "minLength": 1, "nullable": true, "type": "string" } }, "type": "object" }, "ProductFeeds": { "properties": { "data": { "items": { "$ref": "#/components/schemas/ProductFeed" }, "type": "array" }, "paging": { "$ref": "#/components/schemas/PagingData" } }, "type": "object" }, "ProductGroup": { "properties": { "country_code": { "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "description": { "type": "string" }, "image_url": { "type": "string" }, "source_id": { "type": "string" }, "title": { "type": "string" }, "url": { "type": "string" } }, "type": "object" }, "ProductOverride": { "properties": { "availability": { "type": "string" }, "brand_id": { "type": "integer" }, "created_at": { "format": "date-time", "type": "string" }, "currency_code": { "maxLength": 3, "nullable": true, "type": "string" }, "description": { "nullable": true, "type": "string" }, "id": { "type": "integer" }, "image_url": { "maxLength": 750, "nullable": true, "type": "string" }, "last_updated_by_product_feed_at": { "format": "date-time", "nullable": true, "type": "string" }, "original_url": { "maxLength": 750, "nullable": true, "type": "string" }, "override": { "maxLength": 5, "type": "string" }, "price": { "maxLength": 50, "nullable": true, "type": "string" }, "source_id": { "maxLength": 70, "type": "string" }, "title": { "maxLength": 512, "nullable": true, "type": "string" }, "updated_at": { "format": "date-time", "type": "string" }, "url": { "maxLength": 750, "nullable": true, "type": "string" } }, "required": [ "brand_id", "override", "source_id" ], "type": "object" }, "PublicBrandMediaWithProducts": { "properties": { "brand_id": { "type": "integer" }, "duration": {}, "hide_in_widget": {}, "image_sizes": { "readOnly": true }, "media_group": { "type": "string" }, "media_id": { "type": "integer" }, "media_type": {}, "original_height": { "type": "string" }, "original_width": { "type": "string" }, "predictions": { "readOnly": true }, "products": { "items": { "allOf": [ { "$ref": "#/components/schemas/PublicMediaProduct" } ], "description": "List of products associated with the brand media", "readOnly": true }, "type": "array" }, "source_data": { "readOnly": true }, "type": { "enum": [ "instagram_owned", "INSTAGRAM_OWNED", "instagram_ugc", "INSTAGRAM_UGC", "instagram_other", "INSTAGRAM_OTHER", "instagram_owned_igtv", "INSTAGRAM_OWNED_IGTV", "instagram_ugc_igtv", "INSTAGRAM_UGC_IGTV", "instagram_other_igtv", "INSTAGRAM_OTHER_IGTV", "instagram_story", "INSTAGRAM_STORY", "instagram_story_ugc", "INSTAGRAM_STORY_UGC", "instagram_ads", "INSTAGRAM_ADS", "uploaded", "UPLOADED", "edited", "EDITED", "ai_generated", "AI_GENERATED", "pinterest_owned", "PINTEREST_OWNED", "pinterest_story", "PINTEREST_STORY", "pinterest_ugc", "PINTEREST_UGC", "facebook_owned", "FACEBOOK_OWNED", "facebook_ads", "FACEBOOK_ADS", "facebook_post_ad", "FACEBOOK_POST_AD", "facebook_post_ad_l", "FACEBOOK_POST_AD_L", "facebook_post_ad_t", "FACEBOOK_POST_AD_T", "facebook_post_ad_tl", "FACEBOOK_POST_AD_TL", "facebook_link", "FACEBOOK_LINK", "facebook_text_link", "FACEBOOK_TEXT_LINK", "facebook_text", "FACEBOOK_TEXT", "facebook_other", "FACEBOOK_OTHER", "facebook_other_text", "FACEBOOK_OTHER_TEXT", "facebook_other_tl", "FACEBOOK_OTHER_TL", "facebook_other_link", "FACEBOOK_OTHER_LINK", "twitter_owned", "TWITTER_OWNED", "twitter_owned_link", "TWITTER_OWNED_LINK", "twitter_owned_text", "TWITTER_OWNED_TEXT", "twitter_ugc", "TWITTER_UGC", "twitter_ugc_link", "TWITTER_UGC_LINK", "twitter_ugc_text", "TWITTER_UGC_TEXT", "twitter_other", "TWITTER_OTHER", "twitter_other_link", "TWITTER_OTHER_LINK", "twitter_other_text", "TWITTER_OTHER_TEXT", "tiktok_owned", "TIKTOK_OWNED", "tiktok_ugc", "TIKTOK_UGC", "tiktok_other", "TIKTOK_OTHER", "tiktok_ad_owned", "TIKTOK_AD_OWNED", "youtube_owned", "YOUTUBE_OWNED", "youtube_ugc", "YOUTUBE_UGC", "youtube_other", "YOUTUBE_OTHER", "linkedin_owned", "LINKEDIN_OWNED", "threads_owned", "THREADS_OWNED", "snapchat_owned_story", "SNAPCHAT_OWNED_STORY", "snapchat_owned_saved_story", "SNAPCHAT_OWNED_SAVED_STORY", "snapchat_owned_spotlight", "SNAPCHAT_OWNED_SPOTLIGHT", "snapchat_owned_snap", "SNAPCHAT_OWNED_SNAP" ], "type": "string" }, "urls": { "readOnly": true }, "video_sizes": { "readOnly": true } }, "required": [ "brand_id", "media_id", "type" ], "type": "object" }, "PublicFacebookPageDetails": { "properties": { "avatar": { "format": "url", "type": "string" }, "fb_page_id": { "type": "integer" }, "name": { "type": "string" } }, "type": "object" }, "PublicFacebookSourceData": { "properties": { "fb_full_picture": { "format": "url", "type": "string" }, "fb_post_created_at": { "type": "string" }, "fb_post_id": { "type": "string" }, "message": { "type": "string" }, "page_details": { "$ref": "#/components/schemas/PublicFacebookPageDetails" }, "title": { "type": "string" }, "type": { "type": "string" }, "url": { "format": "url", "type": "string" } }, "type": "object" }, "PublicGalleryMedia": { "properties": { "brand_media_notes": { "readOnly": true }, "brand_media_type": { "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "id": { "type": "integer" }, "media": { "$ref": "#/components/schemas/PublicMedia" }, "order": { "type": "number" }, "products": { "items": { "$ref": "#/components/schemas/PublicGalleryMediaProduct" }, "type": "array" }, "updated_at": { "format": "date-time", "type": "string" } }, "type": "object" }, "PublicGalleryMediaList": { "properties": { "data": { "items": { "$ref": "#/components/schemas/PublicGalleryMedia" }, "type": "array" }, "paging": { "$ref": "#/components/schemas/PagingData" } }, "type": "object" }, "PublicGalleryMediaProduct": { "properties": { "clicks": { "description": "Clicks of the product for this media.", "type": "integer" }, "description": { "description": "Description of the product.", "type": "string" }, "id": { "description": "ID of the object.", "readOnly": true, "type": "integer" }, "image_url": { "description": "Image URL of the product.", "type": "string" }, "product_groups": { "items": { "$ref": "#/components/schemas/ProductGroup" }, "type": "array" }, "product_overrides": { "items": { "$ref": "#/components/schemas/ProductOverride" }, "type": "array" }, "source_id": { "description": "Source ID of the product (SKU or brand's product ID).", "type": "string" }, "title": { "description": "Title of the product.", "type": "string" }, "url": { "description": "URL of the product.", "type": "string" }, "x": { "description": "X coordinate of the product displayed in this media.", "type": "number" }, "y": { "description": "Y coordinate of the product displayed in this media.", "type": "number" } }, "type": "object" }, "PublicImageMedia": { "properties": { "editor_data": { "allOf": [ { "$ref": "#/components/schemas/ImageEditorData" } ], "description": "Contains UI state for our image editing tools." }, "sizes": { "readOnly": true }, "transforms": { "allOf": [ { "$ref": "#/components/schemas/ImageTransforms" } ], "description": "Transforms that are applied to the image. Currently transforms for images are handled client-side, but this may change in the future." } }, "type": "object" }, "PublicInstagramSourceData": { "properties": { "caption": { "type": "string" }, "comments_count": { "type": "integer" }, "deleted": { "type": "integer" }, "id": { "type": "string" }, "image_url": { "format": "url", "type": "string" }, "instagram_media_type": { "type": "string" }, "instagram_user": { "$ref": "#/components/schemas/PublicInstagramUser" }, "is_mentioned": { "type": "boolean" }, "library_id": { "type": "integer" }, "like_count": { "type": "integer" }, "media": { "items": { "type": "object" }, "type": "array" }, "timestamp": { "type": "string" }, "total_comments": { "type": "integer" }, "total_likes": { "type": "integer" }, "type": { "type": "string" }, "url": { "format": "url", "type": "string" } }, "type": "object" }, "PublicInstagramStorySourceData": { "properties": { "caption": { "type": "string" }, "date": { "type": "string" }, "duration": { "type": "number" }, "fb_media_id": { "type": "integer" }, "hashtags": { "items": { "type": "string" }, "type": "array" }, "instagram_id": { "type": "integer" }, "instagram_user": { "$ref": "#/components/schemas/PublicInstagramUser" }, "media_id": { "type": "string" }, "short_url": { "format": "url", "type": "string" }, "thumb": { "format": "url", "type": "string" }, "url": { "format": "url", "type": "string" } }, "type": "object" }, "PublicInstagramUser": { "properties": { "bio": { "type": "string" }, "bio_url": { "format": "url", "type": "string" }, "followers": { "type": "integer" }, "following": { "type": "integer" }, "handle": { "type": "string" }, "instagram_id": { "type": "integer" }, "is_business": { "type": "boolean" } }, "type": "object" }, "PublicLinkedinSourceData": { "properties": { "account_details": { "type": "object" }, "account_id": { "type": "integer" }, "api_created_at": { "type": "string" }, "caption": { "type": "string" }, "comments": { "type": "integer" }, "created_at": { "type": "string" }, "deleted_at": { "type": "string" }, "id": { "type": "integer" }, "library_media_id": { "type": "integer" }, "linkedin_link": { "format": "url", "type": "string" }, "source_created_at": { "type": "string" }, "source_post_id": { "type": "string" }, "thumbnail_url": { "format": "url", "type": "string" }, "type": { "type": "string" }, "updated_at": { "type": "string" } }, "type": "object" }, "PublicMedia": { "properties": { "created_at": { "format": "date-time", "type": "string" }, "duration": {}, "id": { "type": "integer" }, "image_sizes": { "readOnly": true }, "media_group": { "type": "integer" }, "original_height": { "type": "integer" }, "original_width": { "type": "integer" }, "source": { "type": "string" }, "source_created_at": { "format": "date-time", "type": "string" }, "source_data": { "readOnly": true }, "source_id": { "type": "string" }, "type": { "type": "string" }, "updated_at": { "format": "date-time", "type": "string" }, "urls": { "readOnly": true }, "video_sizes": { "readOnly": true } }, "type": "object" }, "PublicMediaProduct": { "properties": { "bounding_box": { "nullable": true }, "created_at": { "format": "date-time", "type": "string" }, "deleted": { "nullable": true, "type": "integer" }, "deleted_at": { "format": "date-time", "nullable": true, "type": "string" }, "description": { "type": "string" }, "hide_in_widget": { "nullable": true, "type": "integer" }, "id": { "type": "integer" }, "image_url": { "type": "string" }, "product": { "$ref": "#/components/schemas/Product1" }, "product_groups": { "items": { "$ref": "#/components/schemas/ProductGroup" }, "type": "array" }, "product_id": { "type": "integer" }, "source_id": { "type": "string" }, "title": { "type": "string" }, "updated_at": { "format": "date-time", "type": "string" }, "url": { "type": "string" }, "x": { "type": "number" }, "y": { "type": "number" } }, "type": "object" }, "PublicMediaV2": { "properties": { "brand_id": { "readOnly": true, "type": "integer" }, "created_at": { "description": "An ISO-8601 formatted timestamp of when the object was created.", "format": "date-time", "readOnly": true, "type": "string" }, "facebook": { "allOf": [ { "$ref": "#/components/schemas/PublicFacebookSourceData" } ], "description": "Public Facebook source data.", "readOnly": true }, "id": { "description": "The object's ID.", "readOnly": true, "type": "integer" }, "image": { "allOf": [ { "$ref": "#/components/schemas/PublicImageMedia" } ], "description": "Public image data if type is `IMAGE`." }, "instagram": { "allOf": [ { "$ref": "#/components/schemas/PublicInstagramSourceData" } ], "description": "Public Instagram source data.", "readOnly": true }, "instagram_ads": { "description": "Instagram ads source data.", "readOnly": true, "type": "object" }, "instagram_story": { "allOf": [ { "$ref": "#/components/schemas/PublicInstagramStorySourceData" } ], "description": "Public Instagram story source data.", "readOnly": true }, "instagram_story_frame": { "description": "Instagram story frame source data.", "readOnly": true, "type": "object" }, "instagram_user": { "description": "Instagram User source data.", "readOnly": true, "type": "object" }, "linkedin": { "allOf": [ { "$ref": "#/components/schemas/PublicLinkedinSourceData" } ], "description": "Public LinkedIn source data.", "readOnly": true }, "pinterest": { "allOf": [ { "$ref": "#/components/schemas/PublicPinterestSourceData" } ], "description": "Public Pinterest source data.", "readOnly": true }, "source": { "description": "Source of media.", "enum": [ "INSTAGRAM", "INSTAGRAM_STORY", "PINTEREST", "FACEBOOK", "TIKTOK", "TIKTOK_AD", "TWITTER", "YOUTUBE", "LINKEDIN", "THREADS", "SNAPCHAT", "UPLOAD", "EDITOR", "AI_GENERATION", "FACEBOOK_ADS", "FACEBOOK_LINK", "FACEBOOK_TEXT", "FACEBOOK_TEXT_LINK", "TWITTER_LINK", "TWITTER_TEXT" ], "type": "string" }, "source_created_at": { "description": "An ISO-8601 formatted timestamp of when the source object was created.", "format": "date-time", "type": "string" }, "source_id": { "description": "Source ID of media.", "readOnly": true, "type": "string" }, "source_type": { "description": "Type of source.", "enum": [ "UGC", "OWNED", "OTHER" ], "type": "string" }, "tiktok": { "allOf": [ { "$ref": "#/components/schemas/PublicTiktokSourceData" } ], "description": "Public TikTok source data.", "readOnly": true }, "twitter": { "allOf": [ { "$ref": "#/components/schemas/PublicTwitterSourceData" } ], "description": "Public Twitter source data.", "readOnly": true }, "type": { "description": "Type of media.", "enum": [ "IMAGE", "VIDEO", "CAROUSEL", "REEL" ], "type": "string" }, "updated_at": { "description": "An ISO-8601 formatted timestamp of when the object was last updated.", "format": "date-time", "readOnly": true, "type": "string" }, "variants": { "description": "Variants of media: TEXT, LINK", "items": { "enum": [ "TEXT", "LINK" ], "type": "string" }, "type": "array" }, "video": { "allOf": [ { "$ref": "#/components/schemas/PublicVideoMedia" } ], "description": "Public video data if type is `VIDEO`." }, "video_suggested_thumbnail_list": { "items": { "allOf": [ { "$ref": "#/components/schemas/VideoSuggestedThumbnail" } ], "description": "List of suggested thumbnails for higher engagement", "readOnly": true }, "type": "array" }, "youtube": { "allOf": [ { "$ref": "#/components/schemas/PublicYoutubeSourceData" } ], "description": "Public YouTube source data", "readOnly": true } }, "required": [ "source", "type" ], "type": "object" }, "PublicPinner": { "properties": { "avatar_url": { "format": "url", "type": "string" }, "username": { "type": "string" } }, "type": "object" }, "PublicPinterestSourceData": { "properties": { "image_height": { "type": "integer" }, "image_url": { "format": "url", "type": "string" }, "image_width": { "type": "integer" }, "link": { "format": "url", "type": "string" }, "media_id": { "type": "integer" }, "pin_board_id": { "type": "string" }, "pin_board_name": { "type": "string" }, "pin_created_at": { "type": "string" }, "pin_id": { "type": "string" }, "pinner": { "$ref": "#/components/schemas/PublicPinner" }, "source_url": { "format": "url", "type": "string" }, "title": { "type": "string" } }, "type": "object" }, "PublicTiktokSourceData": { "properties": { "account_details": { "type": "object" }, "account_id": { "type": "integer" }, "caption": { "type": "string" }, "comments": { "type": "integer" }, "duration": { "type": "number" }, "embed_url": { "format": "url", "type": "string" }, "likes": { "type": "integer" }, "share_url": { "format": "url", "type": "string" }, "thumbnail_url": { "format": "url", "type": "string" }, "tiktok_video_id": { "type": "string" }, "video_created_at": { "type": "string" } }, "type": "object" }, "PublicTwitterAccountDetails": { "properties": { "handle": { "type": "string" }, "total_followers": { "type": "integer" }, "twitter_avatar": { "format": "url", "type": "string" }, "twitter_user_id": { "type": "string" } }, "type": "object" }, "PublicTwitterSourceData": { "properties": { "account_details": { "$ref": "#/components/schemas/PublicTwitterAccountDetails" }, "additional_media_urls": { "items": { "format": "url", "type": "string" }, "type": "array" }, "created_at": { "type": "string" }, "is_promoted": { "type": "boolean" }, "media_id": { "type": "integer" }, "permalink_url": { "format": "url", "type": "string" }, "quote_tweets": { "type": "integer" }, "replies": { "type": "integer" }, "retweets": { "type": "integer" }, "text": { "type": "string" }, "tweet_id": { "type": "string" }, "type": { "type": "string" }, "url": { "format": "url", "type": "string" } }, "type": "object" }, "PublicVideoMedia": { "properties": { "duration": { "description": "Duration of the video in seconds.", "readOnly": true, "type": "number" }, "editor_data": { "allOf": [ { "$ref": "#/components/schemas/VideoEditorData" } ], "description": "Contains UI state for our video editing tools." }, "frame_rate": { "description": "Frame rate of the video.", "readOnly": true, "type": "number" }, "sizes": { "readOnly": true }, "thumbnails": { "allOf": [ { "$ref": "#/components/schemas/VideoThumbnails" } ], "description": "Contains different size thumbnails, taken from the middle of the video.", "readOnly": true }, "transforms": { "allOf": [ { "$ref": "#/components/schemas/VideoTransforms" } ], "description": "Transforms that are applied to the video server-side." }, "video_conversion_warnings": { "description": "Warnings raised during video conversion.", "readOnly": true } }, "type": "object" }, "PublicYoutubeSourceData": { "properties": { "aspect_ratio": { "type": "string" }, "description": { "type": "string" }, "duration": { "type": "integer" }, "embeddable": { "type": "boolean" }, "is_short": { "type": "boolean" }, "likes": { "type": "integer" }, "media_type": { "type": "string" }, "source_published_at": { "type": "string" }, "source_video_id": { "type": "string" }, "title": { "type": "string" }, "youtube_link": { "format": "url", "type": "string" } }, "type": "object" }, "ReindexBrandPostsCustomMetrics": { "properties": { "brand_ids": { "description": "The Brand IDs to update the custom metrics for.", "items": { "type": "integer" }, "minItems": 1, "type": "array" } }, "required": [ "brand_ids" ], "type": "object" }, "RowsAffected": { "properties": { "rows": { "type": "integer" } }, "type": "object" }, "RunContentAutomationResponse": { "properties": { "message": { "type": "string" }, "task_id": { "type": "string" } }, "required": [ "message", "task_id" ], "type": "object" }, "SearchMedia": { "properties": { "filters": { "$ref": "#/components/schemas/MediaFilters" }, "limit": { "default": 100, "description": "Number of results to return in a single response.", "maximum": 1000, "minimum": 0, "type": "integer" }, "offset": { "default": 0, "description": "The offset of the first result to be returned.", "minimum": 0, "type": "integer" }, "sort_fields": { "default": [ "-DATE" ], "description": "List of sort fields to apply. Prefix any value with `-` for descending order (e.g., `-DATE`). For platform-specific sorting, use `{PLATFORM}_{METRIC}` (e.g., `-INSTAGRAM_TOTAL_ENGAGEMENTS`, `-TIKTOK_VIEWS`, `-FACEBOOK_TOTAL_ENGAGEMENTS`). Common platform prefixes: `INSTAGRAM_`, `FACEBOOK_`, `TIKTOK_`, `TWITTER_`, `PINTEREST_`, `YOUTUBE_`, `LINKEDIN_`, `SNAPCHAT_`, `THREADS_`.", "example": [ "-DATE", "-INSTAGRAM_TOTAL_ENGAGEMENTS" ], "items": { "description": "Sort field. Prefix with `-` for descending order.", "example": "-DATE", "type": "string", "enum": [ "DATE", "RELEVANCE", "PERFORMANCE", "LIKESHOP_CLICKS", "CROSS_CHANNEL_VIDEO_VIEWS", "CROSS_CHANNEL_ENGAGEMENT_RATE", "CROSS_CHANNEL_IMPRESSIONS", "CROSS_CHANNEL_ENTERTAINMENT_SCORE", "CROSS_CHANNEL_TOTAL_ENGAGEMENTS", "CROSS_CHANNEL_EMV", "CROSS_CHANNEL_EFFECTIVENESS", "CROSS_CHANNEL_REACH", "CROSS_CHANNEL_SHARES", "CONTENT_RIGHTS_EXPIRY_DATE", "CONTENT_RIGHTS_REQUESTED_DATE" ] }, "type": "array" }, "sort": { "description": "Sort field for results. Prefix with `-` for descending order (e.g., `-DATE`). For platform-specific sorting, use the format `{PLATFORM}_{METRIC}` (e.g., `-INSTAGRAM_TOTAL_ENGAGEMENTS`, `-TIKTOK_VIEWS`). Deprecated in favor of `sort_fields`.", "example": "-DATE", "type": "string", "enum": [ "DATE", "RELEVANCE", "PERFORMANCE", "LIKESHOP_CLICKS", "CROSS_CHANNEL_VIDEO_VIEWS", "CROSS_CHANNEL_ENGAGEMENT_RATE", "CROSS_CHANNEL_IMPRESSIONS", "CROSS_CHANNEL_ENTERTAINMENT_SCORE", "CROSS_CHANNEL_TOTAL_ENGAGEMENTS", "CROSS_CHANNEL_EMV", "CROSS_CHANNEL_EFFECTIVENESS", "CROSS_CHANNEL_REACH", "CROSS_CHANNEL_SHARES", "CONTENT_RIGHTS_EXPIRY_DATE", "CONTENT_RIGHTS_REQUESTED_DATE" ] }, "ids": { "description": "Array of media ids to return", "example": [ 1234, 4567 ], "items": { "type": "integer" }, "type": "array" }, "include_creator": { "default": false, "description": "Should include creator info", "type": "boolean" }, "include_instagram_users": { "description": "Should include instagram users", "type": "boolean" }, "collapse_field": { "description": "Field used to collapse hits (used to avoid duplicate posts)", "example": "source_id", "type": "string" }, "campaign_creator_filters_options": { "allOf": [ { "$ref": "#/components/schemas/CampaignCreatorFiltersOptions" } ], "description": "When passing in a list of campaign IDs as a filter, these are options on how to apply the campaign's creator filters" } }, "type": "object" }, "SearchMediaMultiBrand": { "properties": { "filters": { "$ref": "#/components/schemas/MultiBrandSearchFilters" }, "limit": { "default": 100, "description": "Number of results to return in a single response.", "maximum": 1000, "minimum": 0, "type": "integer" }, "offset": { "default": 0, "description": "The offset of the first result to be returned.", "minimum": 0, "type": "integer" }, "sort": { "description": "Media filter order. \"-\" means in a desc order.", "example": "-DATE", "type": "string" }, "sort_fields": { "default": [ "-DATE" ], "description": "List of sort orders to be applied to search.", "example": [ "-DATE", "-FACEBOOK_TOTAL_ENGAGEMENTS" ], "items": { "description": "Media filter order. (Prefixing an option with `-` sorts in a descending order for this field.)", "example": "-DATE", "type": "string" }, "type": "array" } }, "required": [ "filters" ], "type": "object" }, "SearchProductRequest": { "properties": { "url": { "description": "The URL to query in a Brand's product catalog. Will look for exact match.", "type": "string" } }, "required": [ "url" ], "type": "object" }, "SegmentClusterTag": { "properties": { "brand_id": { "type": "integer" }, "color": { "maxLength": 9, "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "id": { "type": "integer" }, "name": { "maxLength": 50, "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "brand_id", "color", "name" ], "type": "object" }, "Sentiment": { "properties": { "is_negative": { "description": "The overall sentiment of this item is negative.", "type": "boolean" }, "is_neutral": { "description": "The overall sentiment of this item is neutral.", "type": "boolean" }, "is_positive": { "description": "The overall sentiment of this item is positive.", "type": "boolean" }, "user_overridden": { "description": "The original sentiment assigned to this item by library intelligence has been overridden by the user.", "type": "boolean" } }, "type": "object" }, "SentimentQuestion": { "properties": { "is_question": { "description": "Whether this item is a question.", "type": "boolean" }, "user_overridden": { "description": "Whether this item is a question, as determined by library intelligence, has been overridden by the user.", "type": "boolean" } }, "type": "object" }, "Size": { "properties": { "height": { "description": "Height in pixels.", "readOnly": true, "type": "integer" }, "size": { "description": "File size in bytes.", "type": "integer" }, "url": { "description": "Public URL for media.", "format": "url", "type": "string" }, "width": { "description": "Width in pixels.", "readOnly": true, "type": "integer" } }, "required": [ "url" ], "type": "object" }, "SnapchatFilters": { "properties": { "asset_types": { "description": "Snapchat asset types to filter on", "example": [ "STORY", "SAVED_STORY", "SPOTLIGHT", "SNAP" ], "items": { "enum": [ "SAVED_STORY", "SPOTLIGHT", "STORY", "SNAP" ], "type": "string" }, "type": "array" }, "caption_keywords": { "$ref": "#/components/schemas/KeywordFilters" }, "parent_story_source_id": { "description": "Snapchat parent story source id", "example": "ac234340-eb80-5439-9906-8672bb73075c", "type": "string" } }, "type": "object" }, "SocialAdsSummaryMetricItem": { "properties": { "goal": { "default": null, "description": "The goal value for this metric", "nullable": true, "type": "number" }, "metric": { "description": "The metric name. Must be one of TOTAL_SPENT, AVG_COST_PER_CLICK, AVG_COST_PER_MILE, CLICKS_ALL_ADS, IMPRESSIONS_ADS, CLICKS_ADS", "enum": [ "TOTAL_SPENT", "AVG_COST_PER_CLICK", "AVG_COST_PER_MILE", "CLICKS_ALL_ADS", "IMPRESSIONS_ADS", "CLICKS_ADS" ], "type": "string" }, "source": { "description": "The source of the metric data. Must be one of dashboards", "enum": [ "dashboards" ], "type": "string" } }, "required": [ "metric", "source" ], "type": "object" }, "StartGalleryTransferRequest": { "properties": { "brand_label": { "type": "string" }, "gallery_id": { "type": "integer" }, "slack_user_id": { "type": "string" }, "type": { "enum": [ "CURALATE_LIKESHOP", "LINKINBIO_LIKESHOP", "SPRINKLR_LIKESHOP", "SPROUT_LIKESHOP", "CURALATE_GALLERY" ], "type": "string" }, "url": { "format": "url", "type": "string" } }, "required": [ "brand_label", "type", "url" ], "type": "object" }, "StatusOK": { "properties": { "status": { "default": true, "description": "True is returned to indicate request received.", "type": "boolean" } }, "type": "object" }, "TTCMOrderDetails": { "properties": { "ttcm_orders_campaign_code": { "description": "A unique identifier for a TikTok Campaign", "type": "string" }, "ttcm_orders_invite_link": { "description": "URL for inviting creators to a TikTok campaign", "format": "url", "type": "string" }, "ttcm_spark_ads_authorization_days": { "description": "Duration in which `ttcm_orders_invite_link` is valid (in days)", "type": "integer" } }, "type": "object" }, "ThreadsFilters": { "properties": { "caption_keywords": { "$ref": "#/components/schemas/KeywordFilters" }, "post_types": { "description": "Threads post types to filter on", "example": [ "IMAGE", "VIDEO" ], "items": { "enum": [ "TEXT_POST", "IMAGE", "VIDEO", "CAROUSEL_ALBUM", "AUDIO", "REPOST_FACADE" ], "type": "string" }, "type": "array" } }, "type": "object" }, "TikTokAdFilters": { "properties": { "source_campaign_ids": { "items": { "description": "TikTok Ad source campaign id", "example": "123", "type": "string" }, "type": "array" } }, "type": "object" }, "TikTokFilters": { "properties": { "caption_keywords": { "$ref": "#/components/schemas/KeywordFilters" }, "distribution_type": { "description": "How the video was published or distributed on TikTok", "enum": [ "organic", "ORGANIC", "promoted", "PROMOTED", "dark_posted", "DARK_POSTED" ], "example": "ORGANIC", "type": "string" }, "media_type": { "items": { "description": "TikTok content type", "enum": [ "video", "VIDEO", "photo", "PHOTO" ], "example": "VIDEO", "type": "string" }, "type": "array" } }, "type": "object" }, "TikTokUGCFilters": { "properties": { "is_hashtag": { "description": "Is the post branded hashtag.", "example": true, "type": "boolean" } }, "type": "object" }, "TimeRange": { "properties": { "end": { "default": null, "description": "Time range start timestamp in UTC.", "example": "2019-12-01T00:00:00+00:00", "format": "date-time", "nullable": true, "type": "string" }, "start": { "default": null, "description": "Time range start timestamp in UTC.", "example": "2019-12-01T00:00:00+00:00", "format": "date-time", "nullable": true, "type": "string" } }, "type": "object" }, "TopLineMetrics": { "additionalProperties": false, "properties": { "CREATOR_SUMMARY": { "description": "Top line metrics for creator summary", "items": { "$ref": "#/components/schemas/CreatorSummaryMetricItem" }, "nullable": true, "type": "array" }, "OWNED_SUMMARY": { "description": "Top line metrics for owned summary", "items": { "$ref": "#/components/schemas/OwnedSummaryMetricItem" }, "nullable": true, "type": "array" }, "SOCIAL_ADS_SUMMARY": { "description": "Top line metrics for social ads summary", "items": { "$ref": "#/components/schemas/SocialAdsSummaryMetricItem" }, "nullable": true, "type": "array" } }, "type": "object" }, "Trim": { "properties": { "end_time": { "description": "Start time of trim in seconds.", "type": "number" }, "start_time": { "description": "End time of trim in seconds.", "type": "number" } }, "type": "object" }, "TwitterFilters": { "properties": { "caption_keywords": { "$ref": "#/components/schemas/KeywordFilters" }, "is_dark_post": { "description": "Is Media a dark post", "example": true, "type": "boolean" }, "post_types": { "items": { "description": "Post Type", "enum": [ "video", "VIDEO", "photo", "PHOTO", "carousel", "CAROUSEL", "text", "TEXT", "link", "LINK" ], "example": "VIDEO", "type": "string" }, "type": "array" } }, "type": "object" }, "UpdateAffiliateLinkRequest": { "properties": { "link_title": { "description": "Title for the affiliate link (optional)", "nullable": true, "type": "string" }, "target_url": { "description": "Target URL to redirect to (optional)", "nullable": true, "type": "string" }, "utm_parameters": { "allOf": [ { "$ref": "#/components/schemas/UtmParameters" } ], "description": "UTM parameters to add to the target URL (optional)", "nullable": true } }, "type": "object" }, "UpdateAffiliateLinkResponse": { "properties": { "bitlink_id": { "description": "The Bitly link ID", "type": "string" }, "bitlink_url": { "description": "The Bitly short URL", "type": "string" }, "created_at": { "description": "Timestamp when the link was created", "format": "date-time", "type": "string" }, "creator_id": { "description": "ID of the creator associated with the link", "type": "integer" }, "custom_back_half": { "description": "Custom back half for the bitly link", "nullable": true, "type": "string" }, "domain": { "description": "Domain for the bitly link", "type": "string" }, "id": { "description": "ID of the affiliate link", "type": "integer" }, "link_title": { "description": "Title of the affiliate link", "type": "string" }, "long_url": { "description": "The full URL with UTM parameters", "type": "string" }, "target_url": { "description": "The target URL for the affiliate link", "type": "string" }, "utm_parameters": { "allOf": [ { "$ref": "#/components/schemas/UtmParameters" } ], "description": "UTM parameters applied to the URL", "nullable": true } }, "type": "object" }, "UploadFilters": { "properties": { "media_types": { "items": { "description": "Media Type", "example": "VIDEO", "type": "string" }, "type": "array" } }, "type": "object" }, "UrlMetadata": { "properties": { "description": { "description": "A one to two sentence description of the page (og:description).", "readOnly": true, "type": "string" }, "image_url": { "description": "An image URL that should represent the page (og:image).", "readOnly": true, "type": "string" }, "retry_fetch": { "default": false, "description": "If true, retry fetching metadata until title and image are returned (or retries are exhausted). Only works for approved domains.", "type": "boolean", "writeOnly": true }, "source_id": { "description": "The product ID if the page has Open Graph product metadata (product:retailer_item_id).", "readOnly": true, "type": "string" }, "title": { "description": "Title of the page (og:title).", "readOnly": true, "type": "string" }, "url": { "description": "The URL to fetch metadata for.", "format": "url", "type": "string" } }, "required": [ "url" ], "type": "object" }, "UtmEncodePost": { "properties": { "channel": { "description": "The channel, one of likeshop_instagram, likeshop_tiktok, instagram_story, facebook, twitter, pinterest", "enum": [ "facebook", "instagram_story", "likeshop_instagram", "likeshop_tiktok", "pinterest", "twitter" ], "type": "string" }, "content": { "description": "The content of the post", "type": "string" }, "custom_utms": { "additionalProperties": { "type": "string" }, "description": "Key/Value pairs for UTMs. If UTM is editable per post, precedence is as follows:\n 1. UTM value passed the custom_utms field\n 2. UTM value taken from URL in content field (long URL if content URL is shortened)\n 3. UTM value set in the brand's settings\nOtherwise use the value from the brand's settings.", "type": "object" }, "media_id": { "description": "The media id of the post", "type": "integer" }, "product_id": { "description": "Product ID", "type": "integer" }, "shorten_url": { "description": "Whether to shorten the url", "type": "boolean" }, "urls": { "description": "List of urls that appear in the content", "items": { "type": "string" }, "type": "array" } }, "required": [ "channel", "content", "shorten_url" ], "type": "object" }, "UtmEncodedPostResponse": { "properties": { "content": { "description": "The content of the post with encoded URLs", "type": "string" }, "original_content": { "description": "The content of the post with original URLs", "type": "string" }, "parsed_link": { "description": "The link that was extracted from the content", "type": "string" }, "updated_link": { "description": "The link that resuluts from shortening or applying UTMs", "type": "string" } }, "type": "object" }, "UtmParameters": { "properties": { "utm_campaign": { "description": "UTM campaign parameter (e.g., summer-2025-sale)", "type": "string" }, "utm_content": { "description": "UTM content parameter (e.g., summer-collection)", "type": "string" }, "utm_medium": { "description": "UTM medium parameter (e.g., story, post, email)", "type": "string" }, "utm_source": { "description": "UTM source parameter (e.g., instagram, facebook)", "type": "string" }, "utm_term": { "description": "UTM term parameter (e.g., influencer, paid)", "type": "string" } }, "type": "object" }, "UtmPresetValueCreate": { "properties": { "channel": { "description": "The channel", "enum": [ "facebook", "instagram_story", "likeshop_instagram", "likeshop_tiktok", "pinterest", "product_page_gallery", "shoppable_gallery", "twitter" ], "type": "string" }, "tracking_key": { "description": "The tracking key", "type": "string" }, "value": { "description": "The value of the preset value", "type": "string" } }, "type": "object" }, "UtmPresetValueResponse": { "properties": { "channel": { "description": "The channel", "enum": [ "facebook", "instagram_story", "likeshop_instagram", "likeshop_tiktok", "pinterest", "product_page_gallery", "shoppable_gallery", "twitter" ], "type": "string" }, "id": { "description": "The id of the preset value", "type": "integer" }, "tracking_key": { "description": "The tracking key", "type": "string" }, "value": { "description": "The value of the preset value", "type": "string" } }, "type": "object" }, "UtmPresetValueUpdate": { "properties": { "value": { "description": "The value of the preset value", "type": "string" } }, "type": "object" }, "UtmSettingsCreateUpdate": { "additionalProperties": false, "properties": { "facebook": {}, "instagram_story": {}, "likeshop_instagram": {}, "likeshop_tiktok": {}, "pinterest": {}, "twitter": {} }, "type": "object" }, "UtmSettingsDecodeUtms": { "properties": { "channel": { "description": "The channel", "enum": [ "facebook", "instagram_story", "likeshop_instagram", "likeshop_tiktok", "pinterest", "twitter" ], "type": "string" }, "content": { "description": "The URL or content containing URLs to decode", "type": "string" }, "urls": { "description": "List of urls that appear in the content", "items": { "type": "string" }, "type": "array" } }, "required": [ "channel", "content" ], "type": "object" }, "UtmSettingsDecodeUtmsResponse": { "properties": { "has_link": { "description": "Whether the content contains a recognized link of any kind", "type": "boolean" }, "has_shortened_link": { "description": "Flag denoting whether the content contains a shortened link", "type": "boolean" }, "original_content": { "description": "The original content sent in the request.", "type": "string" }, "tracking_parameters": { "description": "The brand's tracking parameters merged with any tracking parameters present in the URL from the request", "type": "object" }, "unshortened_content": { "description": "The original content sent in the request. If content contained a shorturl, the first instance will be replaced with unshortened URL", "type": "string" }, "url_info": { "$ref": "#/components/schemas/UtmSettingsDecodeUtmsUrlInfoResponse" } }, "type": "object" }, "UtmSettingsDecodeUtmsUrlInfoResponse": { "properties": { "parsed_link": { "description": "The link that was extracted from the content", "type": "string" }, "parsed_link_is_short": { "description": "Flag denoting whether the content contains a shortened link", "type": "boolean" }, "parsed_link_query_params": { "additionalProperties": { "description": "Query parameters on the shortened link in the content", "items": { "type": "string" }, "type": "array" }, "type": "object" }, "shortened_link": { "description": "The link that has been hidden by the shortener", "type": "string" }, "shortened_link_query_params": { "additionalProperties": { "description": "Query parameters on the link that has been hidden by the shortener", "items": { "type": "string" }, "type": "array" }, "type": "object" } }, "type": "object" }, "VideoEditorData": { "properties": { "aspect_ratio": { "description": "Label for the aspect ratio preset the user selected. Not validated or used by the backend.", "type": "string" } }, "type": "object" }, "VideoGenerationUsageResponse": { "properties": { "can_access_video_generation": { "type": "boolean" }, "expires_at": { "format": "date-time", "type": "string" }, "id": { "type": "integer" }, "limit": { "type": "integer" }, "used": { "type": "integer" } }, "type": "object" }, "VideoMedia": { "properties": { "duration": { "description": "Duration of the video in seconds.", "readOnly": true, "type": "number" }, "editor_data": { "allOf": [ { "$ref": "#/components/schemas/VideoEditorData" } ], "description": "Contains UI state for our video editing tools." }, "frame_rate": { "description": "Frame rate of the video.", "readOnly": true, "type": "number" }, "sizes": { "allOf": [ { "$ref": "#/components/schemas/VideoSizes" } ], "description": "Contains all available video sizes." }, "thumbnails": { "allOf": [ { "$ref": "#/components/schemas/VideoThumbnails" } ], "description": "Contains different size thumbnails, taken from the middle of the video.", "readOnly": true }, "transforms": { "allOf": [ { "$ref": "#/components/schemas/VideoTransforms" } ], "description": "Transforms that are applied to the video server-side." }, "video_conversion_warnings": { "description": "Warnings raised during video conversion.", "readOnly": true } }, "required": [ "sizes" ], "type": "object" }, "VideoPredictions": { "properties": { "engagement": { "description": "Vision predicted engagement rating for video media.", "items": { "type": "number" }, "type": "array" } }, "type": "object" }, "VideoSizes": { "properties": { "medium_square": { "allOf": [ { "$ref": "#/components/schemas/Size" } ], "description": "Medium video. Cropped to a 1:1 aspect ratio.", "readOnly": true }, "original": { "allOf": [ { "$ref": "#/components/schemas/Size" } ], "description": "Original, unmodified video that was uploaded or imported." }, "original_converted": { "allOf": [ { "$ref": "#/components/schemas/Size" } ], "description": "Original video converted to H.264 format.", "readOnly": true }, "small": { "allOf": [ { "$ref": "#/components/schemas/Size" } ], "description": "Small video. Retains aspect ratio of original.", "readOnly": true }, "small_square": { "allOf": [ { "$ref": "#/components/schemas/Size" } ], "description": "Small video. Cropped to a 1:1 aspect ratio.", "readOnly": true } }, "required": [ "original" ], "type": "object" }, "VideoSuggestedThumbnail": { "properties": { "frame_position": { "description": "The time position of the selected frame in the video", "type": "number" }, "index": { "description": "Index of the VideoPredictions value", "type": "integer" }, "predictions": { "allOf": [ { "$ref": "#/components/schemas/PredictionsV2" } ], "description": "Prediction ratings for the thumbnail" }, "url": { "description": "URL of the suggested thumbnail", "type": "string" } }, "type": "object" }, "VideoThumbnails": { "properties": { "medium_square": { "allOf": [ { "$ref": "#/components/schemas/Size" } ], "description": "Medium thumbnail. Cropped to a 1:1 aspect ratio." }, "original": { "allOf": [ { "$ref": "#/components/schemas/Size" } ], "description": "Original, unmodified thumbnail that was uploaded or imported." }, "original_converted": { "allOf": [ { "$ref": "#/components/schemas/Size" } ], "description": "Original thumbnail converted to JPEG format." }, "small": { "allOf": [ { "$ref": "#/components/schemas/Size" } ], "description": "Small thumbnail. Retains aspect ratio of original video." }, "small_square": { "allOf": [ { "$ref": "#/components/schemas/Size" } ], "description": "Small thumbnail. Cropped to a 1:1 aspect ratio." } }, "type": "object" }, "VideoTransforms": { "properties": { "crop": { "allOf": [ { "$ref": "#/components/schemas/Crop" } ], "description": "Details of video crop.", "nullable": true }, "disable_audio_track": { "description": "`true` if audio track is disabled.", "type": "boolean" }, "parent_media_id": { "description": "If the video has been edited with one of our tools (e.g. the video trimmer) this will be the ID of the original, unedited media.", "type": "integer" }, "trim": { "allOf": [ { "$ref": "#/components/schemas/Trim" } ], "description": "Details of video trim.", "nullable": true } }, "type": "object" }, "YouTubeFilters": { "properties": { "caption_keywords": { "$ref": "#/components/schemas/KeywordFilters" }, "post_types": { "items": { "description": "Post Type", "enum": [ "live", "LIVE", "on_demand", "ON_DEMAND", "shorts", "SHORTS" ], "example": "LIVE", "type": "string" }, "type": "array" }, "privacy_status": { "items": { "description": "Privacy Status", "enum": [ "private", "PRIVATE", "public", "PUBLIC", "unlisted", "UNLISTED" ], "example": "PRIVATE", "type": "string" }, "type": "array" } }, "type": "object" } }, "securitySchemes": { "BearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "API key from Dash Social developer settings" } } }, "info": { "contact": { "email": "support@dashsocial.com", "name": "Dash Social", "url": "https://dashsocial.com" }, "description": "Manage media, galleries, products, and more in the Dash Social platform.", "license": { "name": "Commercial", "url": "https://dashsocial.com/terms" }, "title": "Dash Social Library Backend Service", "version": "1.0", "x-logo": { "altText": "Dash Social logo", "href": "https://developer.dashsocial.com", "url": "https://developer.dashsocial.com/assets/logo.svg" } }, "openapi": "3.0.2", "paths": { "/ai_alternative_media": { "delete": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AiAlternativeMediaDelete" } } }, "required": true }, "responses": { "204": { "description": "No Content" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "tags": [ "AiAlternativeMedia" ] } }, "/brands/campaigns/search": { "post": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignSearchRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignSearchResponse" } } }, "description": "OK" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "tags": [ "CampaignBulk" ] } }, "/brands/galleries/search": { "post": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GallerySearchRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GallerySearchResponse" } } }, "description": "OK" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "tags": [ "ContentContentAutomations" ] } }, "/brands/{brand_id}/ai_alternative_ads": { "delete": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AiAlternativeAdsDelete" } } }, "required": true }, "responses": { "204": { "description": "No Content" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "tags": [ "AiAlternativeAds" ] }, "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "format": "int32", "type": "integer" } } ], "post": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListAiAlternativeAdsRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListAiAlternativeAdsResponse" } } }, "description": "OK" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "tags": [ "AiAlternativeAds" ] } }, "/brands/{brand_id}/ai_alternative_media": { "get": { "parameters": [ { "description": "Number of results to return in a single response.", "in": "query", "name": "limit", "required": false, "schema": { "default": 100, "maximum": 1000, "minimum": 0, "type": "integer" } }, { "description": "The offset of the first result to be returned.", "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "minimum": 0, "type": "integer" } }, { "in": "query", "name": "media_id", "required": true, "schema": { "type": "integer" } }, { "in": "query", "name": "parent_id", "required": false, "schema": { "default": null, "nullable": true, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListAiAlternativeMediaResponse" } } }, "description": "OK" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "tags": [ "BrandAiAlternativeMedia" ] }, "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "format": "int32", "type": "integer" } } ] }, "/brands/{brand_id}/ai_alternative_media/{ai_alternative_media_id}": { "get": { "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AiAlternativeMedia" } } }, "description": "OK" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "tags": [ "BrandAiAlternativeMedia" ] }, "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "format": "int32", "type": "integer" } }, { "in": "path", "name": "ai_alternative_media_id", "required": true, "schema": { "minimum": 0, "type": "integer" } } ] }, "/brands/{brand_id}/bulk_ugc_content_rights_failures": { "delete": { "description": "Sets a Redis key to indicate that the bulk UGC content rights failures\nbanner has been dismissed.", "responses": { "204": { "description": "No Content" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Dismiss the bulk UGC content rights failures banner for a brand.", "tags": [ "Admin" ] }, "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "format": "int32", "type": "integer" } } ] }, "/brands/{brand_id}/campaign_comparisons": { "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "format": "int32", "type": "integer" } } ], "post": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignComparisonCreateJsonRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignComparison" } } }, "description": "OK" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Creates a comparison of campaign A to campaign B.", "tags": [ "Campaign Comparison" ] } }, "/brands/{brand_id}/campaigns": { "get": { "parameters": [ { "description": "Number of results to return in a single response.", "in": "query", "name": "limit", "required": false, "schema": { "default": 100, "maximum": 1000, "minimum": 0, "type": "integer" } }, { "description": "The offset of the first result to be returned.", "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "minimum": 0, "type": "integer" } }, { "description": "Comma-separated list of IDs to return.", "explode": false, "in": "query", "name": "ids", "required": false, "schema": { "items": { "type": "integer" }, "type": "array" }, "style": "form" }, { "description": "Returns a list of summary campaign objects.", "in": "query", "name": "summary", "required": false, "schema": { "type": "boolean" } }, { "description": "Search for campaigns based on name using wildcards", "in": "query", "name": "search", "required": false, "schema": { "default": null, "nullable": true, "type": "string" } }, { "description": "Media filter order. \"-\" means in a desc order.", "in": "query", "name": "sort", "required": false, "schema": { "enum": [ "CREATED", "NAME", "NUMBER_OF_MEDIA", "AVG_ENGAGEMENTS", "AVG_ENGAGEMENT_RATE", "AVG_EMV", "TOTAL_CREATOR_LIKES", "TOTAL_ENGAGEMENTS", "TOTAL_EMV", "TOTAL_CLICKS", "TOTAL_IMPRESSIONS", "TOTAL_VIDEO_VIEWS", "-CREATED", "-NAME", "-NUMBER_OF_MEDIA", "-AVG_ENGAGEMENTS", "-AVG_ENGAGEMENT_RATE", "-AVG_EMV", "-TOTAL_CREATOR_LIKES", "-TOTAL_ENGAGEMENTS", "-TOTAL_EMV", "-TOTAL_CLICKS", "-TOTAL_IMPRESSIONS", "-TOTAL_VIDEO_VIEWS" ], "type": "string" } }, { "description": "Search for campaigns based on the provided creator id", "in": "query", "name": "creator_id", "required": false, "schema": { "nullable": true, "type": "string" } }, { "description": "Only include/exclude campaigns with one or more creators.", "in": "query", "name": "has_creators", "required": false, "schema": { "nullable": true, "type": "boolean" } }, { "description": "Filters campaigns based on whether the current date falls within the range set in the campaign's creator filters. Creator campaigns with nodate range are always considered to be active.", "in": "query", "name": "creator_campaign_status", "required": false, "schema": { "enum": [ "ALL", "ACTIVE", "INACTIVE", null ], "nullable": true, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Campaigns" } } }, "description": "OK" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Retrieve campaigns", "tags": [ "Campaign" ], "x-public": true, "description": "Returns a list of campaigns for a brand." }, "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "format": "int32", "type": "integer" } } ], "post": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Campaign" } } }, "description": "Created" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Create a campaign", "tags": [ "Campaign" ], "x-public": true, "description": "Creates a new campaign for a brand." } }, "/brands/{brand_id}/campaigns/creators/{creator_id}/affiliate_links": { "get": { "parameters": [ { "description": "Number of results to return in a single response.", "in": "query", "name": "limit", "required": false, "schema": { "default": 100, "maximum": 1000, "minimum": 0, "type": "integer" } }, { "description": "The offset of the first result to be returned.", "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "minimum": 0, "type": "integer" } }, { "description": "Campaign name", "in": "query", "name": "campaign_name", "required": false, "schema": { "nullable": true, "type": "string" } }, { "description": "Sort links by field", "in": "query", "name": "sort", "required": false, "schema": { "default": "DATE", "enum": [ "DATE", "CAMPAIGN_NAME", "LINK_TITLE", "AFFILIATE_LINK", "-DATE", "-CAMPAIGN_NAME", "-LINK_TITLE", "-AFFILIATE_LINK" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCreatorAffiliateLinksResponse" } } }, "description": "OK" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Get all affiliate links for a creator across all campaigns in a brand", "tags": [ "AffiliateLinks" ] }, "parameters": [ { "description": "The Dash Social-assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "type": "integer" } }, { "description": "The ID of the creator from creator-backend.", "in": "path", "name": "creator_id", "required": true, "schema": { "type": "integer" } } ] }, "/brands/{brand_id}/campaigns/{campaign_id}": { "delete": { "responses": { "204": { "description": "No Content" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Delete a campaign", "tags": [ "Campaign" ], "x-public": true, "description": "Permanently deletes a campaign." }, "get": { "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Campaign" } } }, "description": "OK" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Retrieve a campaign", "tags": [ "Campaign" ], "x-public": true, "description": "Returns details for a single campaign." }, "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "format": "int32", "type": "integer" } }, { "description": "The ID of the campaign object.", "in": "path", "name": "campaign_id", "required": true, "schema": { "minimum": 0, "type": "integer" } } ], "patch": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Campaign" } } }, "description": "OK" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Update a campaign", "tags": [ "Campaign" ], "x-public": true, "description": "Partially updates a campaign. Only the fields provided in the request body are updated." }, "put": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Campaign" } } }, "description": "OK" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Update a campaign", "tags": [ "Campaign" ], "x-public": true, "description": "Updates all fields of a campaign." } }, "/brands/{brand_id}/campaigns/{campaign_id}/ad_campaigns": { "get": { "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/CampaignAdCampaignResponse" }, "type": "array" } } }, "description": "OK" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Get ad campaigns", "tags": [ "Campaign" ], "x-public": true, "description": "Returns the external ad campaigns (e.g. TikTok Ads, Meta Ads) linked to a Dash Social campaign." }, "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "format": "int32", "type": "integer" } }, { "description": "The ID of the campaign object.", "in": "path", "name": "campaign_id", "required": true, "schema": { "minimum": 0, "type": "integer" } } ], "put": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignUpdateAdCampaignsRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/CampaignAdCampaign" }, "type": "array" } } }, "description": "OK" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Update campaign ad campaigns", "tags": [ "Campaign" ], "x-public": true, "description": "Updates the ad campaigns linked to a Dash Social campaign." } }, "/brands/{brand_id}/campaigns/{campaign_id}/ads/search": { "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "format": "int32", "type": "integer" } }, { "description": "The ID of the campaign object.", "in": "path", "name": "campaign_id", "required": true, "schema": { "minimum": 0, "type": "integer" } } ], "post": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdCampaignsRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdsResponse" } } }, "description": "OK" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Search campaign ads", "tags": [ "Campaign" ], "x-public": true, "description": "Searches for ads associated with a campaign by source channel." } }, "/brands/{brand_id}/campaigns/{campaign_id}/affiliate_links": { "get": { "parameters": [ { "description": "Number of results to return in a single response.", "in": "query", "name": "limit", "required": false, "schema": { "default": 100, "maximum": 1000, "minimum": 0, "type": "integer" } }, { "description": "The offset of the first result to be returned.", "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "minimum": 0, "type": "integer" } }, { "description": "Creator handle", "in": "query", "name": "handle", "required": false, "schema": { "nullable": true, "type": "string" } }, { "description": "Sort creators by field", "in": "query", "name": "sort", "required": false, "schema": { "default": "HANDLE", "enum": [ "HANDLE", "-HANDLE" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCampaignAffiliateLinksResponse" } } }, "description": "OK" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Get all affiliate links for a campaign, grouped by creator.", "tags": [ "AffiliateLinks" ] }, "parameters": [ { "description": "The Dash Social-assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "type": "integer" } }, { "description": "The ID of the campaign object.", "in": "path", "name": "campaign_id", "required": true, "schema": { "type": "integer" } } ], "post": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAffiliateLinkRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAffiliateLinkResponse" } } }, "description": "Created" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "tags": [ "AffiliateLinks" ] } }, "/brands/{brand_id}/campaigns/{campaign_id}/affiliate_links/csv": { "parameters": [ { "in": "path", "name": "brand_id", "required": true, "schema": { "minimum": 0, "type": "integer" } }, { "in": "path", "name": "campaign_id", "required": true, "schema": { "minimum": 0, "type": "integer" } } ], "post": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportAffiliateLinksCSVRequest" } } }, "required": true }, "responses": { "202": { "description": "Accepted" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Export affiliate links for a campaign as CSV", "tags": [ "AffiliateLinks" ] } }, "/brands/{brand_id}/campaigns/{campaign_id}/affiliate_links/{link_id}": { "delete": { "responses": { "204": { "description": "No Content" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "tags": [ "AffiliateLinks" ] }, "parameters": [ { "description": "The Dash Social-assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "type": "integer" } }, { "description": "The ID of the campaign object.", "in": "path", "name": "campaign_id", "required": true, "schema": { "type": "integer" } }, { "description": "The ID of the affiliate link.", "in": "path", "name": "link_id", "required": true, "schema": { "type": "integer" } } ], "patch": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAffiliateLinkRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAffiliateLinkResponse" } } }, "description": "OK" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "tags": [ "AffiliateLinks" ] } }, "/brands/{brand_id}/campaigns/{campaign_id}/benchmarks/creator_summary": { "get": { "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignBenchmarksCreatorSummaryResponse" } } }, "description": "OK" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "tags": [ "CampaignBenchmarks" ] }, "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "format": "int32", "type": "integer" } }, { "description": "The ID of the campaign object.", "in": "path", "name": "campaign_id", "required": true, "schema": { "minimum": 0, "type": "integer" } } ] }, "/brands/{brand_id}/campaigns/{campaign_id}/benchmarks/owned_summary": { "get": { "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignBenchmarksOwnedSummaryResponse" } } }, "description": "OK" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "tags": [ "CampaignBenchmarks" ] }, "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "format": "int32", "type": "integer" } }, { "description": "The ID of the campaign object.", "in": "path", "name": "campaign_id", "required": true, "schema": { "minimum": 0, "type": "integer" } } ] }, "/brands/{brand_id}/campaigns/{campaign_id}/benchmarks/social_ads_summary": { "get": { "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignBenchmarksSocialAdsSummaryResponse" } } }, "description": "OK" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "tags": [ "CampaignBenchmarks" ] }, "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "format": "int32", "type": "integer" } }, { "description": "The ID of the campaign object.", "in": "path", "name": "campaign_id", "required": true, "schema": { "minimum": 0, "type": "integer" } } ] }, "/brands/{brand_id}/campaigns/{campaign_id}/creator_insights/campaign_stats": { "get": { "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignCreatorInsightsResponse" } } }, "description": "OK" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Retrieve Campaign-level Creator insights", "tags": [ "Campaign" ] }, "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "format": "int32", "type": "integer" } }, { "description": "The ID of the campaign object.", "in": "path", "name": "campaign_id", "required": true, "schema": { "minimum": 0, "type": "integer" } } ] }, "/brands/{brand_id}/campaigns/{campaign_id}/creators": { "delete": { "parameters": [ { "description": "A list of IDs identifying DH creators that should be removed from the specified campaign.", "explode": false, "in": "query", "name": "creator_ids", "required": false, "schema": { "items": { "type": "integer" }, "type": "array" }, "style": "form" } ], "responses": { "204": { "description": "No Content" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Soft-delete a list of one or more CampaignCreators based on their creator IDs.", "tags": [ "Campaign" ] }, "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "format": "int32", "type": "integer" } }, { "description": "The ID of the campaign object.", "in": "path", "name": "campaign_id", "required": true, "schema": { "minimum": 0, "type": "integer" } } ] }, "/brands/{brand_id}/campaigns/{campaign_id}/creators/exclude_media": { "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "format": "int32", "type": "integer" } }, { "description": "The ID of the campaign object.", "in": "path", "name": "campaign_id", "required": true, "schema": { "minimum": 0, "type": "integer" } } ], "post": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignExcludeCreatorMediaRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "tags": [ "Campaign" ] } }, "/brands/{brand_id}/campaigns/{campaign_id}/creators/include_media": { "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "format": "int32", "type": "integer" } }, { "description": "The ID of the campaign object.", "in": "path", "name": "campaign_id", "required": true, "schema": { "minimum": 0, "type": "integer" } } ], "post": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignIncludeCreatorMediaRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "tags": [ "Campaign" ] } }, "/brands/{brand_id}/campaigns/{campaign_id}/deliverables": { "get": { "parameters": [ { "description": "Number of results to return in a single response.", "in": "query", "name": "limit", "required": false, "schema": { "default": 100, "maximum": 1000, "minimum": 0, "type": "integer" } }, { "description": "The offset of the first result to be returned.", "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "minimum": 0, "type": "integer" } }, { "description": "A list of comma-separated values indicating the channel to filter upon", "explode": false, "in": "query", "name": "channel", "required": false, "schema": { "items": { "enum": [ "INSTAGRAM", "TIKTOK", "YOUTUBE" ] }, "type": "array" }, "style": "form" }, { "description": "A list of comma-separated values indicating the type of post to filter upon", "explode": false, "in": "query", "name": "post_type", "required": false, "schema": { "items": { "enum": [ "TIKTOK_VIDEO", "INSTAGRAM_FEED", "INSTAGRAM_REELS", "INSTAGRAM_STORIES", "YOUTUBE_VIDEO", "YOUTUBE_SHORT" ] }, "type": "array" }, "style": "form" }, { "description": "Start date for campaign deliverables reporting period", "in": "query", "name": "date_published_start", "required": false, "schema": { "format": "date", "type": "string" } }, { "description": "End date for campaign deliverables reporting period", "in": "query", "name": "date_published_end", "required": false, "schema": { "format": "date", "type": "string" } }, { "description": "List of tags to filter by (pass as repeated query params, e.g. tags=tag1&tags=tag2)", "explode": true, "in": "query", "name": "tags", "required": false, "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "Whether to match all tags or any tags", "in": "query", "name": "tag_match", "required": false, "schema": { "enum": [ "ANY", "ALL" ], "type": "string" } }, { "description": "A list of comma-separated values indicating the status of the campaign deliverables to filter upon", "explode": false, "in": "query", "name": "status", "required": false, "schema": { "items": { "enum": [ "NEW", "CONTACTED", "AGREEMENT_SENT", "BRIEF_SENT", "PRODUCT_SHIPPED", "IN_PROGRESS", "CREATIVE_APPROVED", "PAYMENT_SENT", "COMPLETE", "DECLINED", "PAYMENT_INITIATED", "PAID" ] }, "type": "array" }, "style": "form" }, { "description": "Partial match the handle of the creators TikTok or Instagram account", "in": "query", "name": "handle", "required": false, "schema": { "type": "string" } }, { "description": "Campaign deliverables filter order. \"-\" means in a desc order.", "in": "query", "name": "sort", "required": false, "schema": { "enum": [ "CREATOR_HANDLE", "DELIVERABLES", "TOTAL_POSTS_FT_YOU", "LATEST_POST_FT_YOU", "STATUS", "-CREATOR_HANDLE", "-DELIVERABLES", "-TOTAL_POSTS_FT_YOU", "-LATEST_POST_FT_YOU", "-STATUS" ], "type": "string" } }, { "in": "query", "name": "should_paginate", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignCreatorDeliverablesResponse" } } }, "description": "OK" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Retrieve Campaign Deliverables", "tags": [ "Campaign" ] }, "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "format": "int32", "type": "integer" } }, { "description": "The ID of the campaign object.", "in": "path", "name": "campaign_id", "required": true, "schema": { "minimum": 0, "type": "integer" } } ], "post": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignCreatorsUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignCreatorDeliverablesResponse" } } }, "description": "OK" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Update Campaign Deliverables", "tags": [ "Campaign" ] } }, "/brands/{brand_id}/campaigns/{campaign_id}/media": { "delete": { "parameters": [ { "description": "A list of comma-separated IDs indicating the media items to perform the action with.Selected media must belong to the specified campaign.", "explode": false, "in": "query", "name": "media_ids", "required": false, "schema": { "items": { "type": "integer" }, "type": "array" }, "style": "form" }, { "description": "A list of comma-separated IDs indicating the gallery items to perform the action with.", "explode": false, "in": "query", "name": "gallery_ids", "required": false, "schema": { "items": { "type": "integer" }, "type": "array" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignMediaBulkUpdateJsonRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Remove campaign media", "tags": [ "Campaign" ], "x-public": true, "description": "Bulk removes owned media from a campaign." }, "get": { "parameters": [ { "description": "Number of results to return in a single response.", "in": "query", "name": "limit", "required": false, "schema": { "default": 100, "maximum": 1000, "minimum": 0, "type": "integer" } }, { "description": "The offset of the first result to be returned.", "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "minimum": 0, "type": "integer" } }, { "description": "Source of media.", "in": "query", "name": "source", "required": false, "schema": { "enum": [ "INSTAGRAM", "PINTEREST", "FACEBOOK", "INSTAGRAM_STORY", "TWITTER", "TIKTOK", "YOUTUBE", "LIKESHOP", "TIKTOK_LIKESHOP", "RELATIONSHIPS", "UGC", "CREATORS_INSTAGRAM", "CREATORS_INSTAGRAM_STORIES" ], "type": "string" } }, { "description": "A formatted datetime string in UTC.", "in": "query", "name": "source_created_on_or_after", "required": false, "schema": { "default": null, "example": "2019-12-01", "nullable": true, "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(Z|((\\+|-)\\d{2}:\\d{2})))?$", "type": "string" } }, { "description": "A formatted datetime string in UTC.", "in": "query", "name": "source_created_on_or_before", "required": false, "schema": { "default": null, "example": "2019-12-12", "nullable": true, "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(Z|((\\+|-)\\d{2}:\\d{2})))?$", "type": "string" } }, { "description": "Post Type, VIDEO or POST", "in": "query", "name": "post_type", "required": false, "schema": { "default": null, "enum": [ "VIDEO", "POST", null ], "example": "VIDEO", "nullable": true, "type": "string" } }, { "description": "Sort by field. \"-\" for descending.", "in": "query", "name": "sort", "required": false, "schema": { "enum": [ "DATE", "INSTAGRAM_PAID_COMMENTS", "INSTAGRAM_ENGAGEMENT_RATE", "INSTAGRAM_ENGAGEMENT_RATE_IMPRESSIONS", "INSTAGRAM_PAID_ENGAGEMENT_RATE", "INSTAGRAM_TOTAL_VIDEO_VIEWS", "INSTAGRAM_TOTAL_ENGAGEMENTS", "INSTAGRAM_PAID_TOTAL_ENGAGEMENTS", "INSTAGRAM_SUM_TOTAL_ENGAGEMENTS", "INSTAGRAM_EFFECTIVENESS", "INSTAGRAM_ENGAGEMENT_RATE_PUBLIC", "INSTAGRAM_ENGAGEMENT_RATE_VIEWS", "INSTAGRAM_TOTAL_LIKES", "INSTAGRAM_REACH", "INSTAGRAM_ORGANIC_LIKES", "INSTAGRAM_TOTAL_IMPRESSIONS", "INSTAGRAM_PAID_LIKES", "INSTAGRAM_ORGANIC_IMPRESSIONS", "INSTAGRAM_TOTAL_COMMENTS", "INSTAGRAM_PAID_IMPRESSIONS", "INSTAGRAM_ORGANIC_COMMENTS", "INSTAGRAM_SAVES", "INSTAGRAM_VIDEO_VIEWS", "INSTAGRAM_PAID_VIDEO_VIEWS", "INSTAGRAM_TOTAL_PLAYS", "INSTAGRAM_SHARES", "INSTAGRAM_ENTERTAINMENT_SCORE", "INSTAGRAM_STORY_FRAME_REACH", "INSTAGRAM_STORY_FRAME_IMPRESSIONS", "INSTAGRAM_STORY_FRAME_COMPLETION_RATE", "INSTAGRAM_STORY_FRAME_COMPLETION_RATE_VIEWS", "INSTAGRAM_STORY_FRAME_EMV_VIEWS", "INSTAGRAM_STORY_FRAME_EXITS", "INSTAGRAM_STORY_FRAME_EXIT_RATE", "INSTAGRAM_STORY_FRAME_EXIT_RATE_VIEWS", "INSTAGRAM_STORY_FRAME_SWIPE_UPS", "INSTAGRAM_STORY_FRAME_REPLIES", "INSTAGRAM_STORY_FRAME_VIEWS", "INSTAGRAM_STORY_FRAME_VIEWS_V2", "INSTAGRAM_STORY_FRAME_TAPS_BACK", "INSTAGRAM_STORY_FRAME_TAPS_FORWARD", "INSTAGRAM_COST_PER_THRUPLAY", "INSTAGRAM_CTR", "INSTAGRAM_CPC", "INSTAGRAM_CPM", "INSTAGRAM_PAID_REACTIONS", "INSTAGRAM_PAID_REACH", "INSTAGRAM_PAID_SAVED", "INSTAGRAM_PAID_SHARES", "INSTAGRAM_PAID_AND_ORGANIC_REACH", "INSTAGRAM_PAID_AND_ORGANIC_SAVED", "INSTAGRAM_PAID_AND_ORGANIC_SHARES", "INSTAGRAM_PROFILE_CLICKS", "INSTAGRAM_PROFILE_CLICKS_BIO_LINK", "INSTAGRAM_PROFILE_CLICKS_CALL", "INSTAGRAM_PROFILE_CLICKS_DIRECTION", "INSTAGRAM_PROFILE_CLICKS_EMAIL", "INSTAGRAM_PROFILE_CLICKS_OTHER", "INSTAGRAM_PROFILE_CLICKS_TEXT", "INSTAGRAM_PROFILE_VISITS", "INSTAGRAM_EMV", "INSTAGRAM_FOLLOWS", "INSTAGRAM_FOLLOWERS_GAINED", "INSTAGRAM_VIEWS", "INSTAGRAM_EFFECTIVENESS_ENGAGEMENTS", "INSTAGRAM_AVG_WATCH_TIME", "INSTAGRAM_TOTAL_WATCH_TIME", "INSTAGRAM_CLICKS", "INSTAGRAM_AMOUNT_SPENT", "INSTAGRAM_THRUPLAYS", "INSTAGRAM_VIDEO_PLAYS_25", "INSTAGRAM_VIDEO_PLAYS_50", "INSTAGRAM_VIDEO_PLAYS_75", "INSTAGRAM_VIDEO_PLAYS_100", "FACEBOOK_AMOUNT_SPEND", "FACEBOOK_COMMENTS", "FACEBOOK_COST_PER_THRUPLAYS", "FACEBOOK_EFFECTIVENESS", "FACEBOOK_ENGAGEMENT_RATE", "FACEBOOK_ENGAGEMENT_RATE_PUBLIC", "FACEBOOK_FREQUENCY", "FACEBOOK_TOTAL_ENGAGEMENTS_PUBLIC", "FACEBOOK_IMPRESSIONS", "FACEBOOK_LIKES", "FACEBOOK_LINK_CLICKS", "FACEBOOK_OTHER_CLICKS", "FACEBOOK_PHOTO_VIEW_CLICKS", "FACEBOOK_POST_CLICKS", "FACEBOOK_REACH", "FACEBOOK_REACTIONS", "FACEBOOK_SHARES", "FACEBOOK_THRUPLAYS", "FACEBOOK_TOTAL_ENGAGEMENTS", "FACEBOOK_VIDEO_COMPLETE_VIEWS", "FACEBOOK_VIDEO_PLAYS_25", "FACEBOOK_VIDEO_PLAYS_50", "FACEBOOK_VIDEO_PLAYS_75", "FACEBOOK_VIDEO_VIEWS", "FACEBOOK_BLUE_REELS_PLAYS_COUNT", "FACEBOOK_REELS_EFFECTIVENESS", "FACEBOOK_REELS_FB_REELS_TOTAL_PLAYS", "FACEBOOK_REELS_POST_IMPRESSIONS_UNIQUE", "FACEBOOK_REELS_POST_VIDEO_AVG_TIME_WATCHED", "FACEBOOK_REELS_POST_VIDEO_FOLLOWERS", "FACEBOOK_REELS_POST_VIDEO_VIEW_TIME", "FACEBOOK_REELS_REACTION_ANGRY", "FACEBOOK_REELS_REACTION_HAHA", "FACEBOOK_REELS_REACTION_LIKE", "FACEBOOK_REELS_REACTION_LOVE", "FACEBOOK_REELS_REACTION_SAD", "FACEBOOK_REELS_REACTION_WOW", "FACEBOOK_REELS_REPLAY_COUNT", "FACEBOOK_ORGANIC_COMMENTS", "FACEBOOK_ORGANIC_EFFECTIVENESS", "FACEBOOK_ORGANIC_ENGAGEMENTS", "FACEBOOK_ORGANIC_ENGAGEMENT_RATE", "FACEBOOK_ORGANIC_IMPRESSIONS", "FACEBOOK_ORGANIC_LINK_CLICKS", "FACEBOOK_ORGANIC_REACH", "FACEBOOK_ORGANIC_REACTIONS", "FACEBOOK_ORGANIC_SHARES", "FACEBOOK_ORGANIC_VIDEO_COMPLETE_VIEWS", "FACEBOOK_ORGANIC_VIDEO_VIEWS", "FACEBOOK_PAID_COMMENTS", "FACEBOOK_CTR", "FACEBOOK_CPC", "FACEBOOK_CPM", "FACEBOOK_PAID_ENGAGEMENTS", "FACEBOOK_PAID_ENGAGEMENT_RATE", "FACEBOOK_PAID_IMPRESSIONS", "FACEBOOK_PAID_LINK_CLICKS", "FACEBOOK_PAID_REACH", "FACEBOOK_PAID_REACTIONS", "FACEBOOK_PAID_SHARES", "FACEBOOK_PAID_VIDEO_COMPLETE_VIEWS", "FACEBOOK_PAID_VIDEO_VIEWS", "FACEBOOK_PAID_AND_ORGANIC_COMMENTS", "FACEBOOK_PAID_AND_ORGANIC_IMPRESSIONS", "FACEBOOK_PAID_AND_ORGANIC_LINK_CLICKS", "FACEBOOK_PAID_AND_ORGANIC_OTHER_CLICKS", "FACEBOOK_PAID_AND_ORGANIC_PHOTO_VIEW_CLICKS", "FACEBOOK_PAID_AND_ORGANIC_POST_CLICKS", "FACEBOOK_PAID_AND_ORGANIC_REACH", "FACEBOOK_PAID_AND_ORGANIC_REACTIONS", "FACEBOOK_PAID_AND_ORGANIC_SHARES", "FACEBOOK_PAID_AND_ORGANIC_VIDEO_COMPLETE_VIEWS", "FACEBOOK_PAID_AND_ORGANIC_VIDEO_VIEWS", "FACEBOOK_PAID_AND_ORGANIC_ENGAGEMENT_RATE_V2", "FACEBOOK_PAID_AND_ORGANIC_ENGAGEMENTS_V2", "FACEBOOK_PAID_AND_ORGANIC_EFFECTIVENESS_V2", "FACEBOOK_PAID_AND_ORGANIC_REACH_V2", "FACEBOOK_PAID_AND_ORGANIC_VIEWS", "FACEBOOK_ORGANIC_ENGAGEMENT_RATE_V2", "FACEBOOK_ORGANIC_ENGAGEMENTS_V2", "FACEBOOK_ORGANIC_EFFECTIVENESS_V2", "FACEBOOK_ORGANIC_REACH_V2", "FACEBOOK_ORGANIC_VIEWS", "FACEBOOK_PAID_ENGAGEMENT_RATE_V2", "FACEBOOK_PAID_EFFECTIVENESS_V2", "FACEBOOK_PAID_REACH_V2", "FACEBOOK_PAID_VIEWS", "LIKESHOP_CLICKS", "LINKEDIN_CLICK_THROUGH_RATE", "LINKEDIN_CLICKS", "LINKEDIN_COMMENTS", "LINKEDIN_ENGAGEMENT_RATE", "LINKEDIN_ENGAGEMENTS", "LINKEDIN_IMPRESSIONS", "LINKEDIN_LIKES", "LINKEDIN_SHARES", "LINKEDIN_UNIQUE_IMPRESSIONS", "LINKEDIN_VIDEO_ANALYTICS_VIDEO_VIEWS", "LINKEDIN_VIDEO_ANALYTICS_TIME_WATCHED_FOR_VIEWS", "SNAPCHAT_AVG_VIEW_TIME_SECONDS", "SNAPCHAT_COMPLETES", "SNAPCHAT_ENGAGEMENTS", "SNAPCHAT_ENGAGEMENT_RATE", "SNAPCHAT_FAVORITES", "SNAPCHAT_INTERACTIONS", "SNAPCHAT_REPLIES", "SNAPCHAT_SCREENSHOTS", "SNAPCHAT_SHARES", "SNAPCHAT_SWIPE_DOWNS", "SNAPCHAT_SWIPE_UPS", "SNAPCHAT_UNIQUE_SESSIONS", "SNAPCHAT_VIEWERS", "SNAPCHAT_VIEWS", "SNAPCHAT_VIEW_TIME_SECONDS", "TWITTER_ENGAGEMENT_RATE", "TWITTER_FOLLOWS", "TWITTER_IMPRESSIONS", "TWITTER_LIKES", "TWITTER_USER_PROFILE_CLICKS", "TWITTER_QUOTE_TWEETS", "TWITTER_REPLIES", "TWITTER_RETWEETS", "TWITTER_TOTAL_ENGAGEMENTS", "TWITTER_SUM_TOTAL_ENGAGEMENTS", "TWITTER_TOTAL_RETWEETS", "TWITTER_URL_CLICKS", "TWITTER_VIDEO_VIEWS", "TWITTER_PUBLIC_ENGAGEMENTS", "PINTEREST_ENGAGEMENT_RATE", "PINTEREST_ENGAGEMENTS", "PINTEREST_TOTAL_CLICKS", "PINTEREST_TOTAL_SAVES", "PINTEREST_TOTAL_IMPRESSIONS", "PINTEREST_TOTAL_CLOSEUPS", "PINTEREST_TOTAL_VIDEO_VIEWS", "PINTEREST_AVERAGE_VIDEO_WATCH_TIME", "THREADS_ENGAGEMENT_RATE", "THREADS_ENGAGEMENTS", "THREADS_LIKES", "THREADS_QUOTES", "THREADS_REPLIES", "THREADS_REPOSTS", "THREADS_REPOSTS_AND_QUOTES", "THREADS_SHARES", "THREADS_VIEWS", "TIKTOK_AVERAGE_TIME_WATCHED", "TIKTOK_COMMENTS", "TIKTOK_FULL_VIDEO_WATCHED_RATE", "TIKTOK_EFFECTIVENESS", "TIKTOK_EMV", "TIKTOK_EXIT_RATE_VIEWS", "TIKTOK_IMPRESSIONS_FOLLOW_RATE", "TIKTOK_IMPRESSIONS_FOR_YOU_RATE", "TIKTOK_IMPRESSIONS_HASHTAG_RATE", "TIKTOK_LIKES", "TIKTOK_IMPRESSIONS_PERSONAL_PROFILE_RATE", "TIKTOK_AVERAGE_COMPLETION_RATE", "TIKTOK_IMPRESSIONS_SEARCH_RATE", "TIKTOK_VIDEO_VIEWS", "TIKTOK_SHARES", "TIKTOK_IMPRESSIONS_SOUND_RATE", "TIKTOK_TOTAL_ENGAGEMENTS", "TIKTOK_TOTAL_TIME_WATCHED", "TIKTOK_VIEWS", "TIKTOK_ENGAGEMENT_RATE", "TIKTOK_VIEWS_BASED_ENGAGEMENT_RATE", "TIKTOK_REACH", "TIKTOK_DURATION", "TIKTOK_ENTERTAINMENT_SCORE", "TIKTOK_PAID_LIKES", "TIKTOK_PAID_COMMENTS", "TIKTOK_PAID_SHARES", "TIKTOK_PAID_ENGAGEMENTS", "TIKTOK_PAID_VIEWS", "TIKTOK_PAID_REACH", "TIKTOK_PAID_ENGAGEMENT_RATE", "TIKTOK_PAID_VIEWS_BASED_ENGAGEMENT_RATE", "TIKTOK_ORGANIC_LIKES", "TIKTOK_ORGANIC_COMMENTS", "TIKTOK_ORGANIC_SHARES", "TIKTOK_ORGANIC_ENGAGEMENTS", "TIKTOK_ORGANIC_VIEWS", "TIKTOK_ORGANIC_REACH", "TIKTOK_ORGANIC_ENGAGEMENT_RATE", "TIKTOK_ORGANIC_VIEWS_BASED_ENGAGEMENT_RATE", "TIKTOK_FAVORITES", "TIKTOK_NEW_FOLLOWERS", "TIKTOK_PROFILE_VIEWS", "TIKTOK_PAID_NEW_FOLLOWERS", "TIKTOK_PAID_PROFILE_VIEWS", "TIKTOK_ORGANIC_NEW_FOLLOWERS", "TIKTOK_ORGANIC_PROFILE_VIEWS", "YOUTUBE_AVG_VIEW_DURATION", "YOUTUBE_AVG_VIEW_PERCENTAGE", "YOUTUBE_CARD_IMPRESSIONS", "YOUTUBE_CARD_CLICKS", "YOUTUBE_CARD_CLICK_RATE", "YOUTUBE_CARD_TEASER_CLICKS", "YOUTUBE_CARD_TEASER_CLICK_RATE", "YOUTUBE_CARD_TEASER_IMPRESSIONS", "YOUTUBE_COMMENTS", "YOUTUBE_DISLIKES", "YOUTUBE_EMV", "YOUTUBE_ENGAGEMENT_RATE", "YOUTUBE_ENGAGEMENTS", "YOUTUBE_EST_SECONDS_WATCHED", "YOUTUBE_EST_PREMIUM_SECONDS_WATCHED", "YOUTUBE_LIKES", "YOUTUBE_PREMIUM_VIEWS", "YOUTUBE_SHARES", "YOUTUBE_SUBSCRIBERS", "YOUTUBE_SUBSCRIBERS_GAINED", "YOUTUBE_SUBSCRIBERS_LOST", "YOUTUBE_VIDEOS_ADDED_TO_PLAYLIST", "YOUTUBE_VIEWS", "PERFORMANCE", "CROSS_CHANNEL_VIDEO_VIEWS", "CROSS_CHANNEL_ENGAGEMENT_RATE", "CROSS_CHANNEL_IMPRESSIONS", "CROSS_CHANNEL_ENTERTAINMENT_SCORE", "CROSS_CHANNEL_TOTAL_ENGAGEMENTS", "CROSS_CHANNEL_EMV", "CROSS_CHANNEL_EFFECTIVENESS", "CROSS_CHANNEL_REACH", "CROSS_CHANNEL_SHARES", "CONTENT_RIGHTS_EXPIRY_DATE", "CONTENT_RIGHTS_REQUESTED_DATE", "RELEVANCE", "-DATE", "-INSTAGRAM_PAID_COMMENTS", "-INSTAGRAM_ENGAGEMENT_RATE", "-INSTAGRAM_ENGAGEMENT_RATE_IMPRESSIONS", "-INSTAGRAM_PAID_ENGAGEMENT_RATE", "-INSTAGRAM_TOTAL_VIDEO_VIEWS", "-INSTAGRAM_TOTAL_ENGAGEMENTS", "-INSTAGRAM_PAID_TOTAL_ENGAGEMENTS", "-INSTAGRAM_SUM_TOTAL_ENGAGEMENTS", "-INSTAGRAM_EFFECTIVENESS", "-INSTAGRAM_ENGAGEMENT_RATE_PUBLIC", "-INSTAGRAM_ENGAGEMENT_RATE_VIEWS", "-INSTAGRAM_TOTAL_LIKES", "-INSTAGRAM_REACH", "-INSTAGRAM_ORGANIC_LIKES", "-INSTAGRAM_TOTAL_IMPRESSIONS", "-INSTAGRAM_PAID_LIKES", "-INSTAGRAM_ORGANIC_IMPRESSIONS", "-INSTAGRAM_TOTAL_COMMENTS", "-INSTAGRAM_PAID_IMPRESSIONS", "-INSTAGRAM_ORGANIC_COMMENTS", "-INSTAGRAM_SAVES", "-INSTAGRAM_VIDEO_VIEWS", "-INSTAGRAM_PAID_VIDEO_VIEWS", "-INSTAGRAM_TOTAL_PLAYS", "-INSTAGRAM_SHARES", "-INSTAGRAM_ENTERTAINMENT_SCORE", "-INSTAGRAM_STORY_FRAME_REACH", "-INSTAGRAM_STORY_FRAME_IMPRESSIONS", "-INSTAGRAM_STORY_FRAME_COMPLETION_RATE", "-INSTAGRAM_STORY_FRAME_COMPLETION_RATE_VIEWS", "-INSTAGRAM_STORY_FRAME_EMV_VIEWS", "-INSTAGRAM_STORY_FRAME_EXITS", "-INSTAGRAM_STORY_FRAME_EXIT_RATE", "-INSTAGRAM_STORY_FRAME_EXIT_RATE_VIEWS", "-INSTAGRAM_STORY_FRAME_SWIPE_UPS", "-INSTAGRAM_STORY_FRAME_REPLIES", "-INSTAGRAM_STORY_FRAME_VIEWS", "-INSTAGRAM_STORY_FRAME_VIEWS_V2", "-INSTAGRAM_STORY_FRAME_TAPS_BACK", "-INSTAGRAM_STORY_FRAME_TAPS_FORWARD", "-INSTAGRAM_COST_PER_THRUPLAY", "-INSTAGRAM_CTR", "-INSTAGRAM_CPC", "-INSTAGRAM_CPM", "-INSTAGRAM_PAID_REACTIONS", "-INSTAGRAM_PAID_REACH", "-INSTAGRAM_PAID_SAVED", "-INSTAGRAM_PAID_SHARES", "-INSTAGRAM_PAID_AND_ORGANIC_REACH", "-INSTAGRAM_PAID_AND_ORGANIC_SAVED", "-INSTAGRAM_PAID_AND_ORGANIC_SHARES", "-INSTAGRAM_PROFILE_CLICKS", "-INSTAGRAM_PROFILE_CLICKS_BIO_LINK", "-INSTAGRAM_PROFILE_CLICKS_CALL", "-INSTAGRAM_PROFILE_CLICKS_DIRECTION", "-INSTAGRAM_PROFILE_CLICKS_EMAIL", "-INSTAGRAM_PROFILE_CLICKS_OTHER", "-INSTAGRAM_PROFILE_CLICKS_TEXT", "-INSTAGRAM_PROFILE_VISITS", "-INSTAGRAM_EMV", "-INSTAGRAM_FOLLOWS", "-INSTAGRAM_FOLLOWERS_GAINED", "-INSTAGRAM_VIEWS", "-INSTAGRAM_EFFECTIVENESS_ENGAGEMENTS", "-INSTAGRAM_AVG_WATCH_TIME", "-INSTAGRAM_TOTAL_WATCH_TIME", "-INSTAGRAM_CLICKS", "-INSTAGRAM_AMOUNT_SPENT", "-INSTAGRAM_THRUPLAYS", "-INSTAGRAM_VIDEO_PLAYS_25", "-INSTAGRAM_VIDEO_PLAYS_50", "-INSTAGRAM_VIDEO_PLAYS_75", "-INSTAGRAM_VIDEO_PLAYS_100", "-FACEBOOK_AMOUNT_SPEND", "-FACEBOOK_COMMENTS", "-FACEBOOK_COST_PER_THRUPLAYS", "-FACEBOOK_EFFECTIVENESS", "-FACEBOOK_ENGAGEMENT_RATE", "-FACEBOOK_ENGAGEMENT_RATE_PUBLIC", "-FACEBOOK_FREQUENCY", "-FACEBOOK_TOTAL_ENGAGEMENTS_PUBLIC", "-FACEBOOK_IMPRESSIONS", "-FACEBOOK_LIKES", "-FACEBOOK_LINK_CLICKS", "-FACEBOOK_OTHER_CLICKS", "-FACEBOOK_PHOTO_VIEW_CLICKS", "-FACEBOOK_POST_CLICKS", "-FACEBOOK_REACH", "-FACEBOOK_REACTIONS", "-FACEBOOK_SHARES", "-FACEBOOK_THRUPLAYS", "-FACEBOOK_TOTAL_ENGAGEMENTS", "-FACEBOOK_VIDEO_COMPLETE_VIEWS", "-FACEBOOK_VIDEO_PLAYS_25", "-FACEBOOK_VIDEO_PLAYS_50", "-FACEBOOK_VIDEO_PLAYS_75", "-FACEBOOK_VIDEO_VIEWS", "-FACEBOOK_BLUE_REELS_PLAYS_COUNT", "-FACEBOOK_REELS_EFFECTIVENESS", "-FACEBOOK_REELS_FB_REELS_TOTAL_PLAYS", "-FACEBOOK_REELS_POST_IMPRESSIONS_UNIQUE", "-FACEBOOK_REELS_POST_VIDEO_AVG_TIME_WATCHED", "-FACEBOOK_REELS_POST_VIDEO_FOLLOWERS", "-FACEBOOK_REELS_POST_VIDEO_VIEW_TIME", "-FACEBOOK_REELS_REACTION_ANGRY", "-FACEBOOK_REELS_REACTION_HAHA", "-FACEBOOK_REELS_REACTION_LIKE", "-FACEBOOK_REELS_REACTION_LOVE", "-FACEBOOK_REELS_REACTION_SAD", "-FACEBOOK_REELS_REACTION_WOW", "-FACEBOOK_REELS_REPLAY_COUNT", "-FACEBOOK_ORGANIC_COMMENTS", "-FACEBOOK_ORGANIC_EFFECTIVENESS", "-FACEBOOK_ORGANIC_ENGAGEMENTS", "-FACEBOOK_ORGANIC_ENGAGEMENT_RATE", "-FACEBOOK_ORGANIC_IMPRESSIONS", "-FACEBOOK_ORGANIC_LINK_CLICKS", "-FACEBOOK_ORGANIC_REACH", "-FACEBOOK_ORGANIC_REACTIONS", "-FACEBOOK_ORGANIC_SHARES", "-FACEBOOK_ORGANIC_VIDEO_COMPLETE_VIEWS", "-FACEBOOK_ORGANIC_VIDEO_VIEWS", "-FACEBOOK_PAID_COMMENTS", "-FACEBOOK_CTR", "-FACEBOOK_CPC", "-FACEBOOK_CPM", "-FACEBOOK_PAID_ENGAGEMENTS", "-FACEBOOK_PAID_ENGAGEMENT_RATE", "-FACEBOOK_PAID_IMPRESSIONS", "-FACEBOOK_PAID_LINK_CLICKS", "-FACEBOOK_PAID_REACH", "-FACEBOOK_PAID_REACTIONS", "-FACEBOOK_PAID_SHARES", "-FACEBOOK_PAID_VIDEO_COMPLETE_VIEWS", "-FACEBOOK_PAID_VIDEO_VIEWS", "-FACEBOOK_PAID_AND_ORGANIC_COMMENTS", "-FACEBOOK_PAID_AND_ORGANIC_IMPRESSIONS", "-FACEBOOK_PAID_AND_ORGANIC_LINK_CLICKS", "-FACEBOOK_PAID_AND_ORGANIC_OTHER_CLICKS", "-FACEBOOK_PAID_AND_ORGANIC_PHOTO_VIEW_CLICKS", "-FACEBOOK_PAID_AND_ORGANIC_POST_CLICKS", "-FACEBOOK_PAID_AND_ORGANIC_REACH", "-FACEBOOK_PAID_AND_ORGANIC_REACTIONS", "-FACEBOOK_PAID_AND_ORGANIC_SHARES", "-FACEBOOK_PAID_AND_ORGANIC_VIDEO_COMPLETE_VIEWS", "-FACEBOOK_PAID_AND_ORGANIC_VIDEO_VIEWS", "-FACEBOOK_PAID_AND_ORGANIC_ENGAGEMENT_RATE_V2", "-FACEBOOK_PAID_AND_ORGANIC_ENGAGEMENTS_V2", "-FACEBOOK_PAID_AND_ORGANIC_EFFECTIVENESS_V2", "-FACEBOOK_PAID_AND_ORGANIC_REACH_V2", "-FACEBOOK_PAID_AND_ORGANIC_VIEWS", "-FACEBOOK_ORGANIC_ENGAGEMENT_RATE_V2", "-FACEBOOK_ORGANIC_ENGAGEMENTS_V2", "-FACEBOOK_ORGANIC_EFFECTIVENESS_V2", "-FACEBOOK_ORGANIC_REACH_V2", "-FACEBOOK_ORGANIC_VIEWS", "-FACEBOOK_PAID_ENGAGEMENT_RATE_V2", "-FACEBOOK_PAID_EFFECTIVENESS_V2", "-FACEBOOK_PAID_REACH_V2", "-FACEBOOK_PAID_VIEWS", "-LIKESHOP_CLICKS", "-LINKEDIN_CLICK_THROUGH_RATE", "-LINKEDIN_CLICKS", "-LINKEDIN_COMMENTS", "-LINKEDIN_ENGAGEMENT_RATE", "-LINKEDIN_ENGAGEMENTS", "-LINKEDIN_IMPRESSIONS", "-LINKEDIN_LIKES", "-LINKEDIN_SHARES", "-LINKEDIN_UNIQUE_IMPRESSIONS", "-LINKEDIN_VIDEO_ANALYTICS_VIDEO_VIEWS", "-LINKEDIN_VIDEO_ANALYTICS_TIME_WATCHED_FOR_VIEWS", "-SNAPCHAT_AVG_VIEW_TIME_SECONDS", "-SNAPCHAT_COMPLETES", "-SNAPCHAT_ENGAGEMENTS", "-SNAPCHAT_ENGAGEMENT_RATE", "-SNAPCHAT_FAVORITES", "-SNAPCHAT_INTERACTIONS", "-SNAPCHAT_REPLIES", "-SNAPCHAT_SCREENSHOTS", "-SNAPCHAT_SHARES", "-SNAPCHAT_SWIPE_DOWNS", "-SNAPCHAT_SWIPE_UPS", "-SNAPCHAT_UNIQUE_SESSIONS", "-SNAPCHAT_VIEWERS", "-SNAPCHAT_VIEWS", "-SNAPCHAT_VIEW_TIME_SECONDS", "-TWITTER_ENGAGEMENT_RATE", "-TWITTER_FOLLOWS", "-TWITTER_IMPRESSIONS", "-TWITTER_LIKES", "-TWITTER_USER_PROFILE_CLICKS", "-TWITTER_QUOTE_TWEETS", "-TWITTER_REPLIES", "-TWITTER_RETWEETS", "-TWITTER_TOTAL_ENGAGEMENTS", "-TWITTER_SUM_TOTAL_ENGAGEMENTS", "-TWITTER_TOTAL_RETWEETS", "-TWITTER_URL_CLICKS", "-TWITTER_VIDEO_VIEWS", "-TWITTER_PUBLIC_ENGAGEMENTS", "-PINTEREST_ENGAGEMENT_RATE", "-PINTEREST_ENGAGEMENTS", "-PINTEREST_TOTAL_CLICKS", "-PINTEREST_TOTAL_SAVES", "-PINTEREST_TOTAL_IMPRESSIONS", "-PINTEREST_TOTAL_CLOSEUPS", "-PINTEREST_TOTAL_VIDEO_VIEWS", "-PINTEREST_AVERAGE_VIDEO_WATCH_TIME", "-THREADS_ENGAGEMENT_RATE", "-THREADS_ENGAGEMENTS", "-THREADS_LIKES", "-THREADS_QUOTES", "-THREADS_REPLIES", "-THREADS_REPOSTS", "-THREADS_REPOSTS_AND_QUOTES", "-THREADS_SHARES", "-THREADS_VIEWS", "-TIKTOK_AVERAGE_TIME_WATCHED", "-TIKTOK_COMMENTS", "-TIKTOK_FULL_VIDEO_WATCHED_RATE", "-TIKTOK_EFFECTIVENESS", "-TIKTOK_EMV", "-TIKTOK_EXIT_RATE_VIEWS", "-TIKTOK_IMPRESSIONS_FOLLOW_RATE", "-TIKTOK_IMPRESSIONS_FOR_YOU_RATE", "-TIKTOK_IMPRESSIONS_HASHTAG_RATE", "-TIKTOK_LIKES", "-TIKTOK_IMPRESSIONS_PERSONAL_PROFILE_RATE", "-TIKTOK_AVERAGE_COMPLETION_RATE", "-TIKTOK_IMPRESSIONS_SEARCH_RATE", "-TIKTOK_VIDEO_VIEWS", "-TIKTOK_SHARES", "-TIKTOK_IMPRESSIONS_SOUND_RATE", "-TIKTOK_TOTAL_ENGAGEMENTS", "-TIKTOK_TOTAL_TIME_WATCHED", "-TIKTOK_VIEWS", "-TIKTOK_ENGAGEMENT_RATE", "-TIKTOK_VIEWS_BASED_ENGAGEMENT_RATE", "-TIKTOK_REACH", "-TIKTOK_DURATION", "-TIKTOK_ENTERTAINMENT_SCORE", "-TIKTOK_PAID_LIKES", "-TIKTOK_PAID_COMMENTS", "-TIKTOK_PAID_SHARES", "-TIKTOK_PAID_ENGAGEMENTS", "-TIKTOK_PAID_VIEWS", "-TIKTOK_PAID_REACH", "-TIKTOK_PAID_ENGAGEMENT_RATE", "-TIKTOK_PAID_VIEWS_BASED_ENGAGEMENT_RATE", "-TIKTOK_ORGANIC_LIKES", "-TIKTOK_ORGANIC_COMMENTS", "-TIKTOK_ORGANIC_SHARES", "-TIKTOK_ORGANIC_ENGAGEMENTS", "-TIKTOK_ORGANIC_VIEWS", "-TIKTOK_ORGANIC_REACH", "-TIKTOK_ORGANIC_ENGAGEMENT_RATE", "-TIKTOK_ORGANIC_VIEWS_BASED_ENGAGEMENT_RATE", "-TIKTOK_FAVORITES", "-TIKTOK_NEW_FOLLOWERS", "-TIKTOK_PROFILE_VIEWS", "-TIKTOK_PAID_NEW_FOLLOWERS", "-TIKTOK_PAID_PROFILE_VIEWS", "-TIKTOK_ORGANIC_NEW_FOLLOWERS", "-TIKTOK_ORGANIC_PROFILE_VIEWS", "-YOUTUBE_AVG_VIEW_DURATION", "-YOUTUBE_AVG_VIEW_PERCENTAGE", "-YOUTUBE_CARD_IMPRESSIONS", "-YOUTUBE_CARD_CLICKS", "-YOUTUBE_CARD_CLICK_RATE", "-YOUTUBE_CARD_TEASER_CLICKS", "-YOUTUBE_CARD_TEASER_CLICK_RATE", "-YOUTUBE_CARD_TEASER_IMPRESSIONS", "-YOUTUBE_COMMENTS", "-YOUTUBE_DISLIKES", "-YOUTUBE_EMV", "-YOUTUBE_ENGAGEMENT_RATE", "-YOUTUBE_ENGAGEMENTS", "-YOUTUBE_EST_SECONDS_WATCHED", "-YOUTUBE_EST_PREMIUM_SECONDS_WATCHED", "-YOUTUBE_LIKES", "-YOUTUBE_PREMIUM_VIEWS", "-YOUTUBE_SHARES", "-YOUTUBE_SUBSCRIBERS", "-YOUTUBE_SUBSCRIBERS_GAINED", "-YOUTUBE_SUBSCRIBERS_LOST", "-YOUTUBE_VIDEOS_ADDED_TO_PLAYLIST", "-YOUTUBE_VIEWS", "-PERFORMANCE", "-CROSS_CHANNEL_VIDEO_VIEWS", "-CROSS_CHANNEL_ENGAGEMENT_RATE", "-CROSS_CHANNEL_IMPRESSIONS", "-CROSS_CHANNEL_ENTERTAINMENT_SCORE", "-CROSS_CHANNEL_TOTAL_ENGAGEMENTS", "-CROSS_CHANNEL_EMV", "-CROSS_CHANNEL_EFFECTIVENESS", "-CROSS_CHANNEL_REACH", "-CROSS_CHANNEL_SHARES", "-CONTENT_RIGHTS_EXPIRY_DATE", "-CONTENT_RIGHTS_REQUESTED_DATE", "-RELEVANCE" ], "type": "string" } }, { "description": "Returns a flat list of summary media objects (id, source, source_created_at).", "in": "query", "name": "summary", "required": false, "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignListMediaResponse" } } }, "description": "OK" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Retrieve campaign media", "tags": [ "Campaign" ], "x-public": true, "description": "Returns owned media associated with a campaign." }, "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "format": "int32", "type": "integer" } }, { "description": "The ID of the campaign object.", "in": "path", "name": "campaign_id", "required": true, "schema": { "minimum": 0, "type": "integer" } } ], "post": { "parameters": [ { "description": "A list of comma-separated IDs indicating the media items to perform the action with.Selected media must belong to the specified campaign.", "explode": false, "in": "query", "name": "media_ids", "required": false, "schema": { "items": { "type": "integer" }, "type": "array" }, "style": "form" }, { "description": "A list of comma-separated IDs indicating the gallery items to perform the action with.", "explode": false, "in": "query", "name": "gallery_ids", "required": false, "schema": { "items": { "type": "integer" }, "type": "array" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignMediaBulkUpdateJsonRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Add media to campaign", "tags": [ "Campaign" ], "x-public": true, "description": "Adds owned media to a campaign." } }, "/brands/{brand_id}/campaigns/{campaign_id}/relationships": { "get": { "description": "Returns the relationship brands associated with a campaign.", "parameters": [ { "description": "Number of results to return in a single response.", "in": "query", "name": "limit", "required": false, "schema": { "default": 100, "maximum": 1000, "minimum": 0, "type": "integer" } }, { "description": "The offset of the first result to be returned.", "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "minimum": 0, "type": "integer" } }, { "description": "Comma-separated list of relationship IDs to return.", "explode": true, "in": "query", "name": "relationship_ids", "required": false, "schema": { "default": [], "items": { "type": "integer" }, "type": "array" }, "style": "form" }, { "description": "A formatted datetime string in UTC.", "in": "query", "name": "start_date", "required": false, "schema": { "default": null, "example": "2019-12-01", "nullable": true, "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(Z|((\\+|-)\\d{2}:\\d{2})))?$", "type": "string" } }, { "description": "A formatted datetime string in UTC.", "in": "query", "name": "end_date", "required": false, "schema": { "default": null, "example": "2019-12-12", "nullable": true, "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(Z|((\\+|-)\\d{2}:\\d{2})))?$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignRelationships" } } }, "description": "OK" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "tags": [ "Campaign" ], "x-public": true, "summary": "Retrieve campaign relationships" }, "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "format": "int32", "type": "integer" } }, { "description": "The ID of the campaign object.", "in": "path", "name": "campaign_id", "required": true, "schema": { "minimum": 0, "type": "integer" } } ] }, "/brands/{brand_id}/campaigns/{campaign_id}/relationships/{relationship_id}/media": { "delete": { "parameters": [ { "description": "A list of comma-separated IDs indicating the media items to perform the action with.Selected media must belong to the specified campaign.", "explode": false, "in": "query", "name": "media_ids", "required": false, "schema": { "items": { "type": "integer" }, "type": "array" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignRelationshipMediaBulkUpdateJsonRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Remove relationship media from campaign", "tags": [ "Campaign" ], "x-public": true, "description": "Bulk removes relationship media from a campaign." }, "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "format": "int32", "type": "integer" } }, { "description": "The ID of the campaign object.", "in": "path", "name": "campaign_id", "required": true, "schema": { "minimum": 0, "type": "integer" } }, { "description": "The ID of the relationship", "in": "path", "name": "relationship_id", "required": true, "schema": { "minimum": 0, "type": "integer" } } ], "post": { "parameters": [ { "description": "A list of comma-separated IDs indicating the media items to perform the action with.Selected media must belong to the specified campaign.", "explode": false, "in": "query", "name": "media_ids", "required": false, "schema": { "items": { "type": "integer" }, "type": "array" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignRelationshipMediaBulkUpdateJsonRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Add relationship media to campaign", "tags": [ "Campaign" ], "x-public": true, "description": "Adds relationship media to a campaign." } }, "/brands/{brand_id}/campaigns/{campaign_id}/stats": { "get": { "parameters": [ { "description": "A formatted datetime string in UTC.", "in": "query", "name": "start_date", "required": false, "schema": { "default": null, "example": "2019-12-01", "nullable": true, "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(Z|((\\+|-)\\d{2}:\\d{2})))?$", "type": "string" } }, { "description": "A formatted datetime string in UTC.", "in": "query", "name": "end_date", "required": false, "schema": { "default": null, "example": "2019-12-12", "nullable": true, "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(Z|((\\+|-)\\d{2}:\\d{2})))?$", "type": "string" } }, { "description": "Scale of graph", "in": "query", "name": "scale", "required": false, "schema": { "default": "DAILY", "enum": [ "DAILY", "MONTHLY", "ALL_TIME" ], "type": "string" } } ], "responses": { "200": { "description": "OK" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Retrieve campaign statistics", "tags": [ "Campaign" ], "x-public": true, "description": "Returns aggregated performance statistics for a campaign." }, "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "format": "int32", "type": "integer" } }, { "description": "The ID of the campaign object.", "in": "path", "name": "campaign_id", "required": true, "schema": { "minimum": 0, "type": "integer" } } ] }, "/brands/{brand_id}/campaigns/{campaign_id}/stats/overview": { "get": { "parameters": [ { "description": "A formatted datetime string in UTC.", "in": "query", "name": "start_date", "required": false, "schema": { "default": null, "example": "2019-12-01", "nullable": true, "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(Z|((\\+|-)\\d{2}:\\d{2})))?$", "type": "string" } }, { "description": "A formatted datetime string in UTC.", "in": "query", "name": "end_date", "required": false, "schema": { "default": null, "example": "2019-12-12", "nullable": true, "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(Z|((\\+|-)\\d{2}:\\d{2})))?$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignStatsOverviewResponseSechema" } } }, "description": "OK" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "tags": [ "Campaign" ] }, "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "format": "int32", "type": "integer" } }, { "description": "The ID of the campaign object.", "in": "path", "name": "campaign_id", "required": true, "schema": { "minimum": 0, "type": "integer" } } ] }, "/brands/{brand_id}/campaigns/{campaign_id}/stats/report": { "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "format": "int32", "type": "integer" } }, { "description": "The ID of the campaign object.", "in": "path", "name": "campaign_id", "required": true, "schema": { "minimum": 0, "type": "integer" } } ], "post": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignStatsXlsxRequest" } } }, "required": true }, "responses": { "202": { "description": "Accepted" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Creates asynchronously a campaign report as XLSX file for provided timerange", "tags": [ "Campaign" ] } }, "/brands/{brand_id}/campaigns/{campaign_id}/stats/sentiment": { "get": { "parameters": [ { "description": "A formatted datetime string in local timezone", "in": "query", "name": "start_date", "required": false, "schema": { "default": null, "example": "2019-12-01", "nullable": true, "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(Z|((\\+|-)\\d{2}:\\d{2})))?$", "type": "string" } }, { "description": "A formatted datetime string in local timezone", "in": "query", "name": "end_date", "required": false, "schema": { "default": null, "example": "2019-12-12", "nullable": true, "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(Z|((\\+|-)\\d{2}:\\d{2})))?$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignStatsSentimentResponse" } } }, "description": "OK" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "tags": [ "Campaign" ] }, "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "format": "int32", "type": "integer" } }, { "description": "The ID of the campaign object.", "in": "path", "name": "campaign_id", "required": true, "schema": { "minimum": 0, "type": "integer" } } ] }, "/brands/{brand_id}/campaigns/{campaign_id}/top_keywords": { "get": { "parameters": [ { "description": "A formatted datetime string in local timezone", "in": "query", "name": "source_created_on_or_after", "required": false, "schema": { "default": null, "example": "2019-12-01", "nullable": true, "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(Z|((\\+|-)\\d{2}:\\d{2})))?$", "type": "string" } }, { "description": "A formatted datetime string in local timezone", "in": "query", "name": "source_created_on_or_before", "required": false, "schema": { "default": null, "example": "2019-12-12", "nullable": true, "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(Z|((\\+|-)\\d{2}:\\d{2})))?$", "type": "string" } }, { "description": "Comma separated list of cloud types to filter by", "explode": false, "in": "query", "name": "cloud_type", "required": true, "schema": { "items": { "enum": [ "words", "hashtags", "emojis", "mentions" ], "type": "string" }, "type": "array" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignTopKeywordsResponse" } } }, "description": "OK" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "tags": [ "Campaign" ] }, "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "format": "int32", "type": "integer" } }, { "description": "The ID of the campaign object.", "in": "path", "name": "campaign_id", "required": true, "schema": { "minimum": 0, "type": "integer" } } ] }, "/brands/{brand_id}/campaigns/{campaign_id}/ttcm_order": { "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "format": "int32", "type": "integer" } }, { "description": "The ID of the campaign object.", "in": "path", "name": "campaign_id", "required": true, "schema": { "minimum": 0, "type": "integer" } } ], "post": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignCreatorTTCMOrder" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignCreatorTTCMOrderResponse" } } }, "description": "OK" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Create TTCM Order", "tags": [ "Campaign" ] } }, "/brands/{brand_id}/campaigns/{campaign_id}/ugc": { "delete": { "parameters": [ { "description": "A list of comma-separated IDs indicating the media items to perform the action with.Selected media must belong to the specified campaign.", "explode": false, "in": "query", "name": "media_ids", "required": false, "schema": { "items": { "type": "integer" }, "type": "array" }, "style": "form" }, { "description": "A list of comma-separated IDs indicating the gallery items to perform the action with.", "explode": false, "in": "query", "name": "gallery_ids", "required": false, "schema": { "items": { "type": "integer" }, "type": "array" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignUgcMediaBulkUpdateJsonRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Remove UGC from campaign", "tags": [ "Campaign" ], "x-public": true, "description": "Bulk removes UGC media from a campaign." }, "get": { "description": "Returns UGC media associated with a campaign.", "parameters": [ { "description": "Media filter order. \"-\" means in a desc order.", "in": "query", "name": "sort", "required": false, "schema": { "example": "-DATE", "type": "string" } }, { "description": "UGC Type", "in": "query", "name": "type", "required": false, "schema": { "enum": [ "mentioned", "MENTIONED", "tagged", "TAGGED", "all", "ALL", "any", "ANY" ], "example": "MENTIONED", "type": "string" } }, { "description": "Limit of records per response.", "in": "query", "name": "limit", "required": false, "schema": { "default": 100, "type": "integer" } }, { "description": "Offset of records.", "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "type": "integer" } }, { "description": "Records after or equals given datetime.", "in": "query", "name": "source_created_on_or_after", "required": false, "schema": { "default": null, "nullable": true, "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(Z|((\\+|-)\\d{2}:\\d{2})))?$", "type": "string" } }, { "description": "Records before or equals given datetime.", "in": "query", "name": "source_created_on_or_before", "required": false, "schema": { "default": null, "nullable": true, "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(Z|((\\+|-)\\d{2}:\\d{2})))?$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaUGCList" } } }, "description": "OK" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "tags": [ "Campaign" ], "x-public": true, "summary": "Retrieve campaign UGC" }, "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "format": "int32", "type": "integer" } }, { "description": "The ID of the campaign object.", "in": "path", "name": "campaign_id", "required": true, "schema": { "minimum": 0, "type": "integer" } } ], "post": { "parameters": [ { "description": "A list of comma-separated IDs indicating the media items to perform the action with.Selected media must belong to the specified campaign.", "explode": false, "in": "query", "name": "media_ids", "required": false, "schema": { "items": { "type": "integer" }, "type": "array" }, "style": "form" }, { "description": "A list of comma-separated IDs indicating the gallery items to perform the action with.", "explode": false, "in": "query", "name": "gallery_ids", "required": false, "schema": { "items": { "type": "integer" }, "type": "array" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignUgcMediaBulkUpdateJsonRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Add UGC to campaign", "tags": [ "Campaign" ], "x-public": true, "description": "Adds UGC media to a campaign." } }, "/brands/{brand_id}/competitors/autocomplete": { "get": { "parameters": [ { "description": "Source channel to search for competitors.", "in": "query", "name": "source", "required": false, "schema": { "enum": [ "instagram", "INSTAGRAM", "twitter", "TWITTER", "youtube", "YOUTUBE", "facebook", "FACEBOOK", "tiktok", "TIKTOK" ], "type": "string" } }, { "description": "Number of results to return in a single response.", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "maximum": 100, "minimum": 0, "type": "integer" } }, { "description": "Option to sort results by", "in": "query", "name": "sorting_options", "required": false, "schema": { "enum": [ "by_handle", "BY_HANDLE" ], "type": "string" } }, { "description": "A string for a handle to search for", "in": "query", "name": "handle", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/AutocompleteResponse" }, "type": "array" } } }, "description": "OK" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "tags": [ "Competitors" ] }, "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "format": "int32", "type": "integer" } } ] }, "/brands/{brand_id}/competitors/count": { "get": { "responses": { "200": { "description": "OK" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "tags": [ "Competitors" ] }, "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "format": "int32", "type": "integer" } } ] }, "/brands/{brand_id}/content-rights/csv": { "get": { "parameters": [ { "description": "The socket id of the requesting entity.", "in": "query", "name": "socket_id", "required": false, "schema": { "default": null, "nullable": true, "type": "string" } }, { "description": "The auth token of the socket connection.", "in": "query", "name": "token", "required": false, "schema": { "default": null, "nullable": true, "type": "string" } }, { "description": "The CSV type.", "in": "query", "name": "type", "required": true, "schema": { "type": "string" } }, { "description": "Filter by content rights requested date start.", "in": "query", "name": "start_date", "required": false, "schema": { "default": null, "format": "date", "nullable": true, "type": "string" } }, { "description": "Filter by content rights requested date end.", "in": "query", "name": "end_date", "required": false, "schema": { "default": null, "format": "date", "nullable": true, "type": "string" } }, { "description": "Filter by content rights status. Defaults to ALL.", "in": "query", "name": "content_rights_type", "required": false, "schema": { "default": "ALL", "type": "string" } }, { "description": "Filter by the user who requested content rights.", "in": "query", "name": "user_id", "required": false, "schema": { "default": null, "nullable": true, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CSVTaskGenerated" } } }, "description": "OK" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Generate a CSV export of content rights media.", "tags": [ "ContentRights" ] }, "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "format": "int32", "type": "integer" } } ] }, "/brands/{brand_id}/galleries": { "get": { "parameters": [ { "description": "Comma-separated list of IDs to return.", "explode": false, "in": "query", "name": "ids", "required": false, "schema": { "items": { "type": "integer" }, "type": "array" }, "style": "form" }, { "description": "Number of results to return in a single response.", "in": "query", "name": "limit", "required": false, "schema": { "default": 100, "maximum": 1000, "minimum": 0, "type": "integer" } }, { "description": "The offset of the first result to be returned.", "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "minimum": 0, "type": "integer" } }, { "description": "The Dash Social assigned ID of the brand.", "in": "query", "name": "brand_id", "required": false, "schema": { "nullable": true, "type": "integer" } }, { "description": "Limits the galleries returned to this type.", "in": "query", "name": "type", "required": false, "schema": { "enum": [ "instagram", "INSTAGRAM", "instagram_likeshop", "INSTAGRAM_LIKESHOP", "pinterest", "PINTEREST", "library", "LIBRARY", "instagram_story", "INSTAGRAM_STORY", "instagram_story_narrative", "INSTAGRAM_STORY_NARRATIVE", "tiktok", "TIKTOK", "tiktok_likeshop", "TIKTOK_LIKESHOP", "facebook", "FACEBOOK", "twitter", "TWITTER", "youtube", "YOUTUBE", "linkedin", "LINKEDIN", "threads", "THREADS", "snapchat", "SNAPCHAT", null ], "nullable": true, "type": "string" } }, { "description": "Limits the galleries returned to types in this list", "explode": false, "in": "query", "name": "types", "required": false, "schema": { "items": { "enum": [ "INSTAGRAM", "INSTAGRAM_LIKESHOP", "PINTEREST", "LIBRARY", "INSTAGRAM_STORY", "INSTAGRAM_STORY_NARRATIVE", "TIKTOK", "TIKTOK_LIKESHOP", "FACEBOOK", "TWITTER", "YOUTUBE", "LINKEDIN", "THREADS", "SNAPCHAT" ], "type": "string" }, "type": "array" }, "style": "form" }, { "description": "Limits the galleries returned to be not have smaller size", "in": "query", "name": "min_size", "required": false, "schema": { "nullable": true, "type": "integer" } }, { "description": "Search for galleries based on name using wildcards", "in": "query", "name": "search", "required": false, "schema": { "default": null, "nullable": true, "type": "string" } }, { "description": "Media filter order. \"-\" means in a desc order.", "in": "query", "name": "sort", "required": false, "schema": { "enum": [ "CREATED", "PUBLISHED_AT", "UPDATED", "NAME", "LIBRARY_TRAFFIC", "PINTEREST_TRAFFIC", "INSTAGRAM_EFFECTIVENESS", "INSTAGRAM_EFFECTIVENESS_ENGAGEMENTS", "INSTAGRAM_REACH", "INSTAGRAM_AVG_REACH", "INSTAGRAM_ENGAGEMENT", "INSTAGRAM_TOTAL_COMMENTS", "INSTAGRAM_TOTAL_LIKES", "IG_STORY_AVG_REACH", "IG_STORY_AVG_IMPRESSIONS", "IG_STORY_AVG_VIEWS", "IG_STORY_AVG_EXIT_RATE", "IG_STORY_AVG_COMPLETION_RATE", "IG_STORY_AVG_EXIT_RATE_VIEWS", "IG_STORY_AVG_COMPLETION_RATE_VIEWS", "IG_STORY_SWIPE_UPS", "TOTAL_ENGAGEMENT", "TOTAL_CLICKS", "TOTAL_SAVES", "TOTAL_IMPRESSIONS", "TOTAL_CLOSEUPS", "TOTAL_COMMENTS", "TIKTOK_AVG_ENGAGEMENT_RATE", "TIKTOK_AVG_RETENTION_RATE", "TIKTOK_AVG_VIDEO_VIEWS", "TIKTOK_TOTAL_REACH", "TIKTOK_TOTAL_VIDEO_VIEWS", "FACEBOOK_AVG_EFFECTIVENESS", "FACEBOOK_AVG_ENGAGEMENT_RATE", "FACEBOOK_AVG_REACH", "FACEBOOK_TOTAL_IMPRESSIONS", "FACEBOOK_TOTAL_ENGAGEMENTS", "FACEBOOK_AVG_PAID_AND_ORGANIC_EFFECTIVENESS_V2", "FACEBOOK_AVG_PAID_AND_ORGANIC_ENGAGEMENT_RATE_V2", "FACEBOOK_AVG_PAID_AND_ORGANIC_REACH_V2", "FACEBOOK_TOTAL_PAID_AND_ORGANIC_VIEWS", "FACEBOOK_TOTAL_PAID_AND_ORGANIC_ENGAGEMENTS_V2", "TWITTER_AVG_ENGAGEMENT_RATE", "TWITTER_IMPRESSIONS", "TWITTER_LIKES", "TWITTER_RETWEETS", "TWITTER_TOTAL_ENGAGEMENTS", "YOUTUBE_AVG_VIEW_DURATION", "YOUTUBE_SUBSCRIBERS", "YOUTUBE_TOTAL_ENGAGEMENTS", "YOUTUBE_TOTAL_VIDEO_VIEWS", "YOUTUBE_TOTAL_WATCH_TIME", "LINKEDIN_TOTAL_IMPRESSIONS", "LINKEDIN_AVG_UNIQUE_IMPRESSIONS", "LINKEDIN_TOTAL_LIKES", "LINKEDIN_AVG_ENGAGEMENT_RATE", "LINKEDIN_AVG_CLICK_THROUGH_RATE", "THREADS_TOTAL_VIEWS", "THREADS_TOTAL_LIKES", "THREADS_TOTAL_REPLIES", "THREADS_TOTAL_ENGAGEMENTS", "THREADS_AVG_ENGAGEMENT_RATE", "SNAPCHAT_AVG_ENGAGEMENT_RATE", "SNAPCHAT_TOTAL_ENGAGEMENTS", "SNAPCHAT_TOTAL_VIEWS", "SNAPCHAT_TOTAL_VIEWERS", "SNAPCHAT_AVG_VIEW_TIME", "-CREATED", "-PUBLISHED_AT", "-UPDATED", "-NAME", "-LIBRARY_TRAFFIC", "-PINTEREST_TRAFFIC", "-INSTAGRAM_EFFECTIVENESS", "-INSTAGRAM_EFFECTIVENESS_ENGAGEMENTS", "-INSTAGRAM_REACH", "-INSTAGRAM_AVG_REACH", "-INSTAGRAM_ENGAGEMENT", "-INSTAGRAM_TOTAL_COMMENTS", "-INSTAGRAM_TOTAL_LIKES", "-IG_STORY_AVG_REACH", "-IG_STORY_AVG_IMPRESSIONS", "-IG_STORY_AVG_VIEWS", "-IG_STORY_AVG_EXIT_RATE", "-IG_STORY_AVG_COMPLETION_RATE", "-IG_STORY_AVG_EXIT_RATE_VIEWS", "-IG_STORY_AVG_COMPLETION_RATE_VIEWS", "-IG_STORY_SWIPE_UPS", "-TOTAL_ENGAGEMENT", "-TOTAL_CLICKS", "-TOTAL_SAVES", "-TOTAL_IMPRESSIONS", "-TOTAL_CLOSEUPS", "-TOTAL_COMMENTS", "-TIKTOK_AVG_ENGAGEMENT_RATE", "-TIKTOK_AVG_RETENTION_RATE", "-TIKTOK_AVG_VIDEO_VIEWS", "-TIKTOK_TOTAL_REACH", "-TIKTOK_TOTAL_VIDEO_VIEWS", "-FACEBOOK_AVG_EFFECTIVENESS", "-FACEBOOK_AVG_ENGAGEMENT_RATE", "-FACEBOOK_AVG_REACH", "-FACEBOOK_TOTAL_IMPRESSIONS", "-FACEBOOK_TOTAL_ENGAGEMENTS", "-FACEBOOK_AVG_PAID_AND_ORGANIC_EFFECTIVENESS_V2", "-FACEBOOK_AVG_PAID_AND_ORGANIC_ENGAGEMENT_RATE_V2", "-FACEBOOK_AVG_PAID_AND_ORGANIC_REACH_V2", "-FACEBOOK_TOTAL_PAID_AND_ORGANIC_VIEWS", "-FACEBOOK_TOTAL_PAID_AND_ORGANIC_ENGAGEMENTS_V2", "-TWITTER_AVG_ENGAGEMENT_RATE", "-TWITTER_IMPRESSIONS", "-TWITTER_LIKES", "-TWITTER_RETWEETS", "-TWITTER_TOTAL_ENGAGEMENTS", "-YOUTUBE_AVG_VIEW_DURATION", "-YOUTUBE_SUBSCRIBERS", "-YOUTUBE_TOTAL_ENGAGEMENTS", "-YOUTUBE_TOTAL_VIDEO_VIEWS", "-YOUTUBE_TOTAL_WATCH_TIME", "-LINKEDIN_TOTAL_IMPRESSIONS", "-LINKEDIN_AVG_UNIQUE_IMPRESSIONS", "-LINKEDIN_TOTAL_LIKES", "-LINKEDIN_AVG_ENGAGEMENT_RATE", "-LINKEDIN_AVG_CLICK_THROUGH_RATE", "-THREADS_TOTAL_VIEWS", "-THREADS_TOTAL_LIKES", "-THREADS_TOTAL_REPLIES", "-THREADS_TOTAL_ENGAGEMENTS", "-THREADS_AVG_ENGAGEMENT_RATE", "-SNAPCHAT_AVG_ENGAGEMENT_RATE", "-SNAPCHAT_TOTAL_ENGAGEMENTS", "-SNAPCHAT_TOTAL_VIEWS", "-SNAPCHAT_TOTAL_VIEWERS", "-SNAPCHAT_AVG_VIEW_TIME" ], "type": "string" } }, { "description": "List of tags used to limit galleries returned.", "explode": false, "in": "query", "name": "tags", "required": false, "schema": { "items": { "type": "integer" }, "type": "array" }, "style": "form" }, { "description": "Determines if all or any of the tags are used when searching for galleries.", "in": "query", "name": "tags_filter_type", "required": false, "schema": { "default": "OR", "enum": [ "and", "AND", "or", "OR" ], "type": "string" } }, { "description": "Returns a list of summary gallery objects.", "in": "query", "name": "summary", "required": false, "schema": { "type": "boolean" } }, { "description": "Filter live galleries.", "in": "query", "name": "live", "required": false, "schema": { "default": null, "nullable": true, "type": "integer" } }, { "description": "Filter Shoppable galleries.", "in": "query", "name": "spirit_gallery_enabled", "required": false, "schema": { "default": null, "nullable": true, "type": "integer" } }, { "description": "A formatted datetime string in UTC.", "in": "query", "name": "start_date", "required": false, "schema": { "default": null, "example": "2019-12-01", "nullable": true, "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(Z|((\\+|-)\\d{2}:\\d{2})))?$", "type": "string" } }, { "description": "A formatted datetime string in UTC.", "in": "query", "name": "end_date", "required": false, "schema": { "default": null, "example": "2019-12-12", "nullable": true, "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(Z|((\\+|-)\\d{2}:\\d{2})))?$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Galleries" } } }, "description": "OK" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Retrieve galleries", "tags": [ "Gallery" ], "x-public": true, "description": "Returns a list of galleries for a brand." }, "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "minimum": 0, "type": "integer" } } ], "post": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GalleryPost" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Gallery" } } }, "description": "Created" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Create a gallery", "tags": [ "Gallery" ], "x-public": true, "description": "Creates a new gallery for a brand." } }, "/brands/{brand_id}/galleries/csv": { "get": { "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CSVTaskGenerated" } } }, "description": "OK" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Start generation of the CSV for galleries.", "tags": [ "Gallery" ] }, "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "format": "int32", "type": "integer" } } ], "post": { "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CSVTaskGenerated" } } }, "description": "OK" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Start generation of the CSV for galleries.", "tags": [ "Gallery" ] } }, "/brands/{brand_id}/galleries/import_board_media": { "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "format": "int32", "type": "integer" } } ], "post": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GalleryImportBoardMediaRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GalleryImportBoardMediaResponse" } } }, "description": "OK" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "tags": [ "Gallery" ] } }, "/brands/{brand_id}/galleries/likeshop": { "get": { "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Gallery" } } }, "description": "OK" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Retrieve the likeshop gallery for a given brand.", "tags": [ "Gallery" ] }, "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "format": "int32", "type": "integer" } } ] }, "/brands/{brand_id}/galleries/likeshop/capture_email": { "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "minimum": 0, "type": "integer" } } ], "post": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LikeshopGalleryCaptureEmailRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Add a consumer email to a brand's LikeShop gallery", "tags": [ "Gallery" ] } }, "/brands/{brand_id}/galleries/likeshop/custom_content_settings": { "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "format": "int32", "type": "integer" } } ], "patch": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LikeshopGallerySettings" } } }, "required": true }, "responses": { "204": { "description": "No Content" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Update the custom settings related to a Brand's LikeShop Gallery", "tags": [ "Gallery" ] } }, "/brands/{brand_id}/galleries/likeshop/email_submissions": { "get": { "parameters": [ { "description": "Filter results starting from a date in UTC.", "in": "query", "name": "start_date", "required": false, "schema": { "default": null, "example": "2019-12-01", "nullable": true, "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(Z|((\\+|-)\\d{2}:\\d{2})))?$", "type": "string" } }, { "description": "Filter results ending at a date in UTC.", "in": "query", "name": "end_date", "required": false, "schema": { "default": null, "example": "2019-12-12", "nullable": true, "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(Z|((\\+|-)\\d{2}:\\d{2})))?$", "type": "string" } }, { "description": "Number of results to return in a single response.", "in": "query", "name": "limit", "required": false, "schema": { "default": 2000, "maximum": 5000, "minimum": 0, "type": "integer" } }, { "description": "The offset of the result to be returned.", "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "minimum": 0, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsumerEmailCapturedAtResponse" } } }, "description": "OK" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Retrieve a list of emails tracked from the LikeShop email capture", "tags": [ "Gallery" ] }, "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "minimum": 0, "type": "integer" } } ] }, "/brands/{brand_id}/galleries/likeshop/email_submissions/csv": { "get": { "parameters": [ { "description": "The socket id of the requesting entity.", "in": "query", "name": "socket_id", "required": true, "schema": { "type": "string" } }, { "description": "Filter results starting from a date.", "in": "query", "name": "start_date", "required": false, "schema": { "default": null, "nullable": true, "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(Z|((\\+|-)\\d{2}:\\d{2})))?$", "type": "string" } }, { "description": "Filter results ending at a date.", "in": "query", "name": "end_date", "required": false, "schema": { "default": null, "nullable": true, "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(Z|((\\+|-)\\d{2}:\\d{2})))?$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CSVTaskGenerated" } } }, "description": "OK" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Generate a CSV of email submissions for a brand's LikeShop gallery", "tags": [ "Gallery" ] }, "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "minimum": 0, "type": "integer" } } ] }, "/brands/{brand_id}/galleries/likeshop/gallery_media_products/csv": { "get": { "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CSVTaskGenerated" } } }, "description": "OK" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Produce a CSV of LikeShop gallery media grouped by product URLs", "tags": [ "Gallery" ] }, "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "format": "int32", "type": "integer" } } ] }, "/brands/{brand_id}/galleries/likeshop/media": { "get": { "parameters": [ { "description": "Sort by field. \"-\" for descending.", "in": "query", "name": "sort", "required": false, "schema": { "enum": [ "PUBLISHED_AT", "CREATED", "UPDATED", "ORDER", "VISITS", "ADDED", "POSTED", "CLICKS", "LIKESHOP_CLICKS", "PERFORMANCE", "VIDEO_VIEWS", "AVERAGE_VIDEO_WATCH_TIME", "INSTAGRAM_EFFECTIVENESS", "INSTAGRAM_REACH", "INSTAGRAM_ENGAGEMENT", "INSTAGRAM_ORGANIC_COMMENTS", "INSTAGRAM_PAID_COMMENTS", "INSTAGRAM_TOTAL_COMMENTS", "INSTAGRAM_ENGAGEMENT_RATE", "INSTAGRAM_ENGAGEMENT_RATE_VIEWS", "INSTAGRAM_ORGANIC_IMPRESSIONS", "INSTAGRAM_PAID_IMPRESSIONS", "INSTAGRAM_TOTAL_IMPRESSIONS", "INSTAGRAM_ORGANIC_LIKES", "INSTAGRAM_PAID_LIKES", "INSTAGRAM_TOTAL_LIKES", "INSTAGRAM_SAVES", "INSTAGRAM_TOTAL_ENGAGEMENTS", "INSTAGRAM_PAID_TOTAL_ENGAGEMENTS", "INSTAGRAM_SUM_TOTAL_ENGAGEMENTS", "INSTAGRAM_VIDEO_VIEWS", "INSTAGRAM_PAID_VIDEO_VIEWS", "INSTAGRAM_TOTAL_VIDEO_VIEWS", "INSTAGRAM_PAID_ENGAGEMENT_RATE", "INSTAGRAM_TOTAL_WATCH_TIME", "INSTAGRAM_STORY_REACH", "INSTAGRAM_STORY_IMPRESSIONS", "INSTAGRAM_STORY_SWIPE_UPS", "INSTAGRAM_STORY_REPLIES", "INSTAGRAM_STORY_EXIT_RATE", "PINTEREST_CLICKS", "PINTEREST_CLOSEUPS", "PINTEREST_COMMENTS", "PINTEREST_ENGAGEMENT", "PINTEREST_IMPRESSIONS", "PINTEREST_SAVES", "PINTEREST_VIDEO_VIEWS", "PINTEREST_AVERAGE_VIDEO_WATCH_TIME", "PINTEREST_ENGAGEMENTS", "DATE", "INSTAGRAM_STORY_FRAME_REACH", "INSTAGRAM_STORY_FRAME_IMPRESSIONS", "INSTAGRAM_STORY_FRAME_COMPLETION_RATE", "INSTAGRAM_STORY_FRAME_EXITS", "INSTAGRAM_STORY_FRAME_EXIT_RATE", "INSTAGRAM_STORY_FRAME_SWIPE_UPS", "INSTAGRAM_STORY_FRAME_REPLIES", "INSTAGRAM_STORY_FRAME_TAPS_BACK", "INSTAGRAM_STORY_FRAME_TAPS_FORWARD", "FACEBOOK_PHOTO_VIEW_CLICKS", "FACEBOOK_POST_CLICKS", "FACEBOOK_COMMENTS", "FACEBOOK_REACH", "FACEBOOK_EFFECTIVENESS", "FACEBOOK_REACTIONS", "FACEBOOK_ENGAGEMENT_RATE", "FACEBOOK_ENGAGEMENT_RATE_PUBLIC", "FACEBOOK_SHARES", "FACEBOOK_IMPRESSIONS", "FACEBOOK_TOTAL_ENGAGEMENTS", "FACEBOOK_TOTAL_ENGAGEMENTS_PUBLIC", "FACEBOOK_LINK_CLICKS", "FACEBOOK_VIDEO_COMPLETE_VIEWS", "FACEBOOK_OTHER_CLICKS", "FACEBOOK_VIDEO_VIEWS", "FACEBOOK_REELS_POST_VIDEO_VIEW_TIME", "FACEBOOK_REELS_POST_IMPRESSIONS_UNIQUE", "TWITTER_ENGAGEMENT_RATE", "TWITTER_IMPRESSIONS", "TWITTER_URL_CLICKS", "TWITTER_USER_PROFILE_CLICKS", "TWITTER_QUOTE_TWEETS", "TWITTER_REPLIES", "TWITTER_RETWEETS", "TWITTER_TOTAL_ENGAGEMENTS", "TWITTER_TOTAL_RETWEETS", "TWITTER_FOLLOWS", "TWITTER_VIDEO_VIEWS", "TIKTOK_REACH", "TIKTOK_AVERAGE_TIME_WATCHED", "TIKTOK_AVERAGE_COMPLETION_RATE", "TIKTOK_COMMENTS", "TIKTOK_IMPRESSIONS_SEARCH_RATE", "TIKTOK_FULL_VIDEO_WATCHED_RATE", "TIKTOK_SHARES", "TIKTOK_ENGAGEMENT_RATE", "TIKTOK_ENTERTAINMENT_SCORE", "TIKTOK_IMPRESSIONS_SOUND_RATE", "TIKTOK_IMPRESSIONS_FOLLOW_RATE", "TIKTOK_TOTAL_ENGAGEMENTS", "TIKTOK_IMPRESSIONS_FOR_YOU_RATE", "TIKTOK_TOTAL_TIME_WATCHED", "TIKTOK_IMPRESSIONS_HASHTAG_RATE", "TIKTOK_DURATION", "TIKTOK_LIKES", "TIKTOK_VIEWS", "TIKTOK_IMPRESSIONS_PERSONAL_PROFILE_RATE", "YOUTUBE_AVG_VIEW_PERCENTAGE", "YOUTUBE_AVG_VIEW_DURATION", "YOUTUBE_CARD_IMPRESSIONS", "YOUTUBE_CARD_CLICKS", "YOUTUBE_CARD_CLICK_RATE", "YOUTUBE_CARD_TEASER_CLICKS", "YOUTUBE_CARD_TEASER_CLICK_RATE", "YOUTUBE_CARD_TEASER_IMPRESSIONS", "YOUTUBE_COMMENTS", "YOUTUBE_DISLIKES", "YOUTUBE_LIKES", "YOUTUBE_PREMIUM_VIEWS", "YOUTUBE_EST_PREMIUM_SECONDS_WATCHED", "YOUTUBE_SHARES", "YOUTUBE_SUBSCRIBERS", "YOUTUBE_ENGAGEMENTS", "YOUTUBE_VIDEOS_ADDED_TO_PLAYLIST", "YOUTUBE_VIEWS", "YOUTUBE_EST_SECONDS_WATCHED", "LINKEDIN_CLICK_THROUGH_RATE", "LINKEDIN_CLICKS", "LINKEDIN_COMMENTS", "LINKEDIN_ENGAGEMENTS", "LINKEDIN_ENGAGEMENT_RATE", "LINKEDIN_IMPRESSIONS", "LINKEDIN_LIKES", "LINKEDIN_SHARES", "LINKEDIN_UNIQUE_IMPRESSIONS", "LINKEDIN_VIDEO_ANALYTICS_VIDEO_VIEWS", "LINKEDIN_VIDEO_ANALYTICS_TIME_WATCHED_FOR_VIEWS", "THREADS_ENGAGEMENTS", "THREADS_ENGAGEMENT_RATE", "THREADS_LIKES", "THREADS_QUOTES", "THREADS_REPLIES", "THREADS_REPOSTS", "THREADS_REPOSTS_AND_QUOTES", "THREADS_SHARES", "THREADS_VIEWS", "SNAPCHAT_AVG_VIEW_TIME_SECONDS", "SNAPCHAT_COMPLETES", "SNAPCHAT_ENGAGEMENT_RATE", "SNAPCHAT_ENGAGEMENTS", "SNAPCHAT_FAVORITES", "SNAPCHAT_INTERACTIONS", "SNAPCHAT_REPLIES", "SNAPCHAT_SHARES", "SNAPCHAT_SWIPE_DOWNS", "SNAPCHAT_SWIPE_UPS", "SNAPCHAT_UNIQUE_SESSIONS", "SNAPCHAT_VIEW_TIME_SECONDS", "SNAPCHAT_VIEWERS", "SNAPCHAT_VIEWS", "-PUBLISHED_AT", "-CREATED", "-UPDATED", "-ORDER", "-VISITS", "-ADDED", "-POSTED", "-CLICKS", "-LIKESHOP_CLICKS", "-PERFORMANCE", "-VIDEO_VIEWS", "-AVERAGE_VIDEO_WATCH_TIME", "-INSTAGRAM_EFFECTIVENESS", "-INSTAGRAM_REACH", "-INSTAGRAM_ENGAGEMENT", "-INSTAGRAM_ORGANIC_COMMENTS", "-INSTAGRAM_PAID_COMMENTS", "-INSTAGRAM_TOTAL_COMMENTS", "-INSTAGRAM_ENGAGEMENT_RATE", "-INSTAGRAM_ENGAGEMENT_RATE_VIEWS", "-INSTAGRAM_ORGANIC_IMPRESSIONS", "-INSTAGRAM_PAID_IMPRESSIONS", "-INSTAGRAM_TOTAL_IMPRESSIONS", "-INSTAGRAM_ORGANIC_LIKES", "-INSTAGRAM_PAID_LIKES", "-INSTAGRAM_TOTAL_LIKES", "-INSTAGRAM_SAVES", "-INSTAGRAM_TOTAL_ENGAGEMENTS", "-INSTAGRAM_PAID_TOTAL_ENGAGEMENTS", "-INSTAGRAM_SUM_TOTAL_ENGAGEMENTS", "-INSTAGRAM_VIDEO_VIEWS", "-INSTAGRAM_PAID_VIDEO_VIEWS", "-INSTAGRAM_TOTAL_VIDEO_VIEWS", "-INSTAGRAM_PAID_ENGAGEMENT_RATE", "-INSTAGRAM_TOTAL_WATCH_TIME", "-INSTAGRAM_STORY_REACH", "-INSTAGRAM_STORY_IMPRESSIONS", "-INSTAGRAM_STORY_SWIPE_UPS", "-INSTAGRAM_STORY_REPLIES", "-INSTAGRAM_STORY_EXIT_RATE", "-PINTEREST_CLICKS", "-PINTEREST_CLOSEUPS", "-PINTEREST_COMMENTS", "-PINTEREST_ENGAGEMENT", "-PINTEREST_IMPRESSIONS", "-PINTEREST_SAVES", "-PINTEREST_VIDEO_VIEWS", "-PINTEREST_AVERAGE_VIDEO_WATCH_TIME", "-PINTEREST_ENGAGEMENTS", "-DATE", "-INSTAGRAM_STORY_FRAME_REACH", "-INSTAGRAM_STORY_FRAME_IMPRESSIONS", "-INSTAGRAM_STORY_FRAME_COMPLETION_RATE", "-INSTAGRAM_STORY_FRAME_EXITS", "-INSTAGRAM_STORY_FRAME_EXIT_RATE", "-INSTAGRAM_STORY_FRAME_SWIPE_UPS", "-INSTAGRAM_STORY_FRAME_REPLIES", "-INSTAGRAM_STORY_FRAME_TAPS_BACK", "-INSTAGRAM_STORY_FRAME_TAPS_FORWARD", "-FACEBOOK_PHOTO_VIEW_CLICKS", "-FACEBOOK_POST_CLICKS", "-FACEBOOK_COMMENTS", "-FACEBOOK_REACH", "-FACEBOOK_EFFECTIVENESS", "-FACEBOOK_REACTIONS", "-FACEBOOK_ENGAGEMENT_RATE", "-FACEBOOK_ENGAGEMENT_RATE_PUBLIC", "-FACEBOOK_SHARES", "-FACEBOOK_IMPRESSIONS", "-FACEBOOK_TOTAL_ENGAGEMENTS", "-FACEBOOK_TOTAL_ENGAGEMENTS_PUBLIC", "-FACEBOOK_LINK_CLICKS", "-FACEBOOK_VIDEO_COMPLETE_VIEWS", "-FACEBOOK_OTHER_CLICKS", "-FACEBOOK_VIDEO_VIEWS", "-FACEBOOK_REELS_POST_VIDEO_VIEW_TIME", "-FACEBOOK_REELS_POST_IMPRESSIONS_UNIQUE", "-TWITTER_ENGAGEMENT_RATE", "-TWITTER_IMPRESSIONS", "-TWITTER_URL_CLICKS", "-TWITTER_USER_PROFILE_CLICKS", "-TWITTER_QUOTE_TWEETS", "-TWITTER_REPLIES", "-TWITTER_RETWEETS", "-TWITTER_TOTAL_ENGAGEMENTS", "-TWITTER_TOTAL_RETWEETS", "-TWITTER_FOLLOWS", "-TWITTER_VIDEO_VIEWS", "-TIKTOK_REACH", "-TIKTOK_AVERAGE_TIME_WATCHED", "-TIKTOK_AVERAGE_COMPLETION_RATE", "-TIKTOK_COMMENTS", "-TIKTOK_IMPRESSIONS_SEARCH_RATE", "-TIKTOK_FULL_VIDEO_WATCHED_RATE", "-TIKTOK_SHARES", "-TIKTOK_ENGAGEMENT_RATE", "-TIKTOK_ENTERTAINMENT_SCORE", "-TIKTOK_IMPRESSIONS_SOUND_RATE", "-TIKTOK_IMPRESSIONS_FOLLOW_RATE", "-TIKTOK_TOTAL_ENGAGEMENTS", "-TIKTOK_IMPRESSIONS_FOR_YOU_RATE", "-TIKTOK_TOTAL_TIME_WATCHED", "-TIKTOK_IMPRESSIONS_HASHTAG_RATE", "-TIKTOK_DURATION", "-TIKTOK_LIKES", "-TIKTOK_VIEWS", "-TIKTOK_IMPRESSIONS_PERSONAL_PROFILE_RATE", "-YOUTUBE_AVG_VIEW_PERCENTAGE", "-YOUTUBE_AVG_VIEW_DURATION", "-YOUTUBE_CARD_IMPRESSIONS", "-YOUTUBE_CARD_CLICKS", "-YOUTUBE_CARD_CLICK_RATE", "-YOUTUBE_CARD_TEASER_CLICKS", "-YOUTUBE_CARD_TEASER_CLICK_RATE", "-YOUTUBE_CARD_TEASER_IMPRESSIONS", "-YOUTUBE_COMMENTS", "-YOUTUBE_DISLIKES", "-YOUTUBE_LIKES", "-YOUTUBE_PREMIUM_VIEWS", "-YOUTUBE_EST_PREMIUM_SECONDS_WATCHED", "-YOUTUBE_SHARES", "-YOUTUBE_SUBSCRIBERS", "-YOUTUBE_ENGAGEMENTS", "-YOUTUBE_VIDEOS_ADDED_TO_PLAYLIST", "-YOUTUBE_VIEWS", "-YOUTUBE_EST_SECONDS_WATCHED", "-LINKEDIN_CLICK_THROUGH_RATE", "-LINKEDIN_CLICKS", "-LINKEDIN_COMMENTS", "-LINKEDIN_ENGAGEMENTS", "-LINKEDIN_ENGAGEMENT_RATE", "-LINKEDIN_IMPRESSIONS", "-LINKEDIN_LIKES", "-LINKEDIN_SHARES", "-LINKEDIN_UNIQUE_IMPRESSIONS", "-LINKEDIN_VIDEO_ANALYTICS_VIDEO_VIEWS", "-LINKEDIN_VIDEO_ANALYTICS_TIME_WATCHED_FOR_VIEWS", "-THREADS_ENGAGEMENTS", "-THREADS_ENGAGEMENT_RATE", "-THREADS_LIKES", "-THREADS_QUOTES", "-THREADS_REPLIES", "-THREADS_REPOSTS", "-THREADS_REPOSTS_AND_QUOTES", "-THREADS_SHARES", "-THREADS_VIEWS", "-SNAPCHAT_AVG_VIEW_TIME_SECONDS", "-SNAPCHAT_COMPLETES", "-SNAPCHAT_ENGAGEMENT_RATE", "-SNAPCHAT_ENGAGEMENTS", "-SNAPCHAT_FAVORITES", "-SNAPCHAT_INTERACTIONS", "-SNAPCHAT_REPLIES", "-SNAPCHAT_SHARES", "-SNAPCHAT_SWIPE_DOWNS", "-SNAPCHAT_SWIPE_UPS", "-SNAPCHAT_UNIQUE_SESSIONS", "-SNAPCHAT_VIEW_TIME_SECONDS", "-SNAPCHAT_VIEWERS", "-SNAPCHAT_VIEWS" ], "type": "string" } }, { "description": "Number of results to return in a single response.", "in": "query", "name": "limit", "required": false, "schema": { "default": 100, "maximum": 1000, "minimum": 1, "type": "integer" } }, { "description": "The offset of the first result to be returned.", "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "minimum": 0, "type": "integer" } }, { "description": "A formatted datetime string in UTC.", "in": "query", "name": "start_date", "required": false, "schema": { "default": null, "example": "2019-12-01", "nullable": true, "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(Z|((\\+|-)\\d{2}:\\d{2})))?$", "type": "string" } }, { "description": "A formatted datetime string in UTC.", "in": "query", "name": "end_date", "required": false, "schema": { "default": null, "example": "2019-12-12", "nullable": true, "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(Z|((\\+|-)\\d{2}:\\d{2})))?$", "type": "string" } }, { "description": "Only return media that have products.", "in": "query", "name": "with_products_only", "required": false, "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GalleryMediaList" } } }, "description": "OK" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "tags": [ "Gallery" ], "x-public": true, "summary": "Retrieve Instagram LikeShop media", "description": "Returns media items in the Instagram LikeShop gallery for a brand." }, "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "minimum": 0, "type": "integer" } } ], "post": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GalleryMediaMultiRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Gallery" } } }, "description": "OK" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Add media to Instagram LikeShop", "tags": [ "Gallery" ], "x-public": true, "description": "Adds media objects to the Instagram LikeShop gallery." } }, "/brands/{brand_id}/galleries/likeshop/media/csv": { "get": { "parameters": [ { "description": "Sort by field. \"-\" for descending.", "in": "query", "name": "sort", "required": false, "schema": { "enum": [ "PUBLISHED_AT", "CREATED", "UPDATED", "ORDER", "VISITS", "ADDED", "POSTED", "CLICKS", "LIKESHOP_CLICKS", "PERFORMANCE", "VIDEO_VIEWS", "AVERAGE_VIDEO_WATCH_TIME", "INSTAGRAM_EFFECTIVENESS", "INSTAGRAM_REACH", "INSTAGRAM_ENGAGEMENT", "INSTAGRAM_ORGANIC_COMMENTS", "INSTAGRAM_PAID_COMMENTS", "INSTAGRAM_TOTAL_COMMENTS", "INSTAGRAM_ENGAGEMENT_RATE", "INSTAGRAM_ENGAGEMENT_RATE_VIEWS", "INSTAGRAM_ORGANIC_IMPRESSIONS", "INSTAGRAM_PAID_IMPRESSIONS", "INSTAGRAM_TOTAL_IMPRESSIONS", "INSTAGRAM_ORGANIC_LIKES", "INSTAGRAM_PAID_LIKES", "INSTAGRAM_TOTAL_LIKES", "INSTAGRAM_SAVES", "INSTAGRAM_TOTAL_ENGAGEMENTS", "INSTAGRAM_PAID_TOTAL_ENGAGEMENTS", "INSTAGRAM_SUM_TOTAL_ENGAGEMENTS", "INSTAGRAM_VIDEO_VIEWS", "INSTAGRAM_PAID_VIDEO_VIEWS", "INSTAGRAM_TOTAL_VIDEO_VIEWS", "INSTAGRAM_PAID_ENGAGEMENT_RATE", "INSTAGRAM_TOTAL_WATCH_TIME", "INSTAGRAM_STORY_REACH", "INSTAGRAM_STORY_IMPRESSIONS", "INSTAGRAM_STORY_SWIPE_UPS", "INSTAGRAM_STORY_REPLIES", "INSTAGRAM_STORY_EXIT_RATE", "PINTEREST_CLICKS", "PINTEREST_CLOSEUPS", "PINTEREST_COMMENTS", "PINTEREST_ENGAGEMENT", "PINTEREST_IMPRESSIONS", "PINTEREST_SAVES", "PINTEREST_VIDEO_VIEWS", "PINTEREST_AVERAGE_VIDEO_WATCH_TIME", "PINTEREST_ENGAGEMENTS", "DATE", "INSTAGRAM_STORY_FRAME_REACH", "INSTAGRAM_STORY_FRAME_IMPRESSIONS", "INSTAGRAM_STORY_FRAME_COMPLETION_RATE", "INSTAGRAM_STORY_FRAME_EXITS", "INSTAGRAM_STORY_FRAME_EXIT_RATE", "INSTAGRAM_STORY_FRAME_SWIPE_UPS", "INSTAGRAM_STORY_FRAME_REPLIES", "INSTAGRAM_STORY_FRAME_TAPS_BACK", "INSTAGRAM_STORY_FRAME_TAPS_FORWARD", "FACEBOOK_PHOTO_VIEW_CLICKS", "FACEBOOK_POST_CLICKS", "FACEBOOK_COMMENTS", "FACEBOOK_REACH", "FACEBOOK_EFFECTIVENESS", "FACEBOOK_REACTIONS", "FACEBOOK_ENGAGEMENT_RATE", "FACEBOOK_ENGAGEMENT_RATE_PUBLIC", "FACEBOOK_SHARES", "FACEBOOK_IMPRESSIONS", "FACEBOOK_TOTAL_ENGAGEMENTS", "FACEBOOK_TOTAL_ENGAGEMENTS_PUBLIC", "FACEBOOK_LINK_CLICKS", "FACEBOOK_VIDEO_COMPLETE_VIEWS", "FACEBOOK_OTHER_CLICKS", "FACEBOOK_VIDEO_VIEWS", "FACEBOOK_REELS_POST_VIDEO_VIEW_TIME", "FACEBOOK_REELS_POST_IMPRESSIONS_UNIQUE", "TWITTER_ENGAGEMENT_RATE", "TWITTER_IMPRESSIONS", "TWITTER_URL_CLICKS", "TWITTER_USER_PROFILE_CLICKS", "TWITTER_QUOTE_TWEETS", "TWITTER_REPLIES", "TWITTER_RETWEETS", "TWITTER_TOTAL_ENGAGEMENTS", "TWITTER_TOTAL_RETWEETS", "TWITTER_FOLLOWS", "TWITTER_VIDEO_VIEWS", "TIKTOK_REACH", "TIKTOK_AVERAGE_TIME_WATCHED", "TIKTOK_AVERAGE_COMPLETION_RATE", "TIKTOK_COMMENTS", "TIKTOK_IMPRESSIONS_SEARCH_RATE", "TIKTOK_FULL_VIDEO_WATCHED_RATE", "TIKTOK_SHARES", "TIKTOK_ENGAGEMENT_RATE", "TIKTOK_ENTERTAINMENT_SCORE", "TIKTOK_IMPRESSIONS_SOUND_RATE", "TIKTOK_IMPRESSIONS_FOLLOW_RATE", "TIKTOK_TOTAL_ENGAGEMENTS", "TIKTOK_IMPRESSIONS_FOR_YOU_RATE", "TIKTOK_TOTAL_TIME_WATCHED", "TIKTOK_IMPRESSIONS_HASHTAG_RATE", "TIKTOK_DURATION", "TIKTOK_LIKES", "TIKTOK_VIEWS", "TIKTOK_IMPRESSIONS_PERSONAL_PROFILE_RATE", "YOUTUBE_AVG_VIEW_PERCENTAGE", "YOUTUBE_AVG_VIEW_DURATION", "YOUTUBE_CARD_IMPRESSIONS", "YOUTUBE_CARD_CLICKS", "YOUTUBE_CARD_CLICK_RATE", "YOUTUBE_CARD_TEASER_CLICKS", "YOUTUBE_CARD_TEASER_CLICK_RATE", "YOUTUBE_CARD_TEASER_IMPRESSIONS", "YOUTUBE_COMMENTS", "YOUTUBE_DISLIKES", "YOUTUBE_LIKES", "YOUTUBE_PREMIUM_VIEWS", "YOUTUBE_EST_PREMIUM_SECONDS_WATCHED", "YOUTUBE_SHARES", "YOUTUBE_SUBSCRIBERS", "YOUTUBE_ENGAGEMENTS", "YOUTUBE_VIDEOS_ADDED_TO_PLAYLIST", "YOUTUBE_VIEWS", "YOUTUBE_EST_SECONDS_WATCHED", "LINKEDIN_CLICK_THROUGH_RATE", "LINKEDIN_CLICKS", "LINKEDIN_COMMENTS", "LINKEDIN_ENGAGEMENTS", "LINKEDIN_ENGAGEMENT_RATE", "LINKEDIN_IMPRESSIONS", "LINKEDIN_LIKES", "LINKEDIN_SHARES", "LINKEDIN_UNIQUE_IMPRESSIONS", "LINKEDIN_VIDEO_ANALYTICS_VIDEO_VIEWS", "LINKEDIN_VIDEO_ANALYTICS_TIME_WATCHED_FOR_VIEWS", "THREADS_ENGAGEMENTS", "THREADS_ENGAGEMENT_RATE", "THREADS_LIKES", "THREADS_QUOTES", "THREADS_REPLIES", "THREADS_REPOSTS", "THREADS_REPOSTS_AND_QUOTES", "THREADS_SHARES", "THREADS_VIEWS", "SNAPCHAT_AVG_VIEW_TIME_SECONDS", "SNAPCHAT_COMPLETES", "SNAPCHAT_ENGAGEMENT_RATE", "SNAPCHAT_ENGAGEMENTS", "SNAPCHAT_FAVORITES", "SNAPCHAT_INTERACTIONS", "SNAPCHAT_REPLIES", "SNAPCHAT_SHARES", "SNAPCHAT_SWIPE_DOWNS", "SNAPCHAT_SWIPE_UPS", "SNAPCHAT_UNIQUE_SESSIONS", "SNAPCHAT_VIEW_TIME_SECONDS", "SNAPCHAT_VIEWERS", "SNAPCHAT_VIEWS", "-PUBLISHED_AT", "-CREATED", "-UPDATED", "-ORDER", "-VISITS", "-ADDED", "-POSTED", "-CLICKS", "-LIKESHOP_CLICKS", "-PERFORMANCE", "-VIDEO_VIEWS", "-AVERAGE_VIDEO_WATCH_TIME", "-INSTAGRAM_EFFECTIVENESS", "-INSTAGRAM_REACH", "-INSTAGRAM_ENGAGEMENT", "-INSTAGRAM_ORGANIC_COMMENTS", "-INSTAGRAM_PAID_COMMENTS", "-INSTAGRAM_TOTAL_COMMENTS", "-INSTAGRAM_ENGAGEMENT_RATE", "-INSTAGRAM_ENGAGEMENT_RATE_VIEWS", "-INSTAGRAM_ORGANIC_IMPRESSIONS", "-INSTAGRAM_PAID_IMPRESSIONS", "-INSTAGRAM_TOTAL_IMPRESSIONS", "-INSTAGRAM_ORGANIC_LIKES", "-INSTAGRAM_PAID_LIKES", "-INSTAGRAM_TOTAL_LIKES", "-INSTAGRAM_SAVES", "-INSTAGRAM_TOTAL_ENGAGEMENTS", "-INSTAGRAM_PAID_TOTAL_ENGAGEMENTS", "-INSTAGRAM_SUM_TOTAL_ENGAGEMENTS", "-INSTAGRAM_VIDEO_VIEWS", "-INSTAGRAM_PAID_VIDEO_VIEWS", "-INSTAGRAM_TOTAL_VIDEO_VIEWS", "-INSTAGRAM_PAID_ENGAGEMENT_RATE", "-INSTAGRAM_TOTAL_WATCH_TIME", "-INSTAGRAM_STORY_REACH", "-INSTAGRAM_STORY_IMPRESSIONS", "-INSTAGRAM_STORY_SWIPE_UPS", "-INSTAGRAM_STORY_REPLIES", "-INSTAGRAM_STORY_EXIT_RATE", "-PINTEREST_CLICKS", "-PINTEREST_CLOSEUPS", "-PINTEREST_COMMENTS", "-PINTEREST_ENGAGEMENT", "-PINTEREST_IMPRESSIONS", "-PINTEREST_SAVES", "-PINTEREST_VIDEO_VIEWS", "-PINTEREST_AVERAGE_VIDEO_WATCH_TIME", "-PINTEREST_ENGAGEMENTS", "-DATE", "-INSTAGRAM_STORY_FRAME_REACH", "-INSTAGRAM_STORY_FRAME_IMPRESSIONS", "-INSTAGRAM_STORY_FRAME_COMPLETION_RATE", "-INSTAGRAM_STORY_FRAME_EXITS", "-INSTAGRAM_STORY_FRAME_EXIT_RATE", "-INSTAGRAM_STORY_FRAME_SWIPE_UPS", "-INSTAGRAM_STORY_FRAME_REPLIES", "-INSTAGRAM_STORY_FRAME_TAPS_BACK", "-INSTAGRAM_STORY_FRAME_TAPS_FORWARD", "-FACEBOOK_PHOTO_VIEW_CLICKS", "-FACEBOOK_POST_CLICKS", "-FACEBOOK_COMMENTS", "-FACEBOOK_REACH", "-FACEBOOK_EFFECTIVENESS", "-FACEBOOK_REACTIONS", "-FACEBOOK_ENGAGEMENT_RATE", "-FACEBOOK_ENGAGEMENT_RATE_PUBLIC", "-FACEBOOK_SHARES", "-FACEBOOK_IMPRESSIONS", "-FACEBOOK_TOTAL_ENGAGEMENTS", "-FACEBOOK_TOTAL_ENGAGEMENTS_PUBLIC", "-FACEBOOK_LINK_CLICKS", "-FACEBOOK_VIDEO_COMPLETE_VIEWS", "-FACEBOOK_OTHER_CLICKS", "-FACEBOOK_VIDEO_VIEWS", "-FACEBOOK_REELS_POST_VIDEO_VIEW_TIME", "-FACEBOOK_REELS_POST_IMPRESSIONS_UNIQUE", "-TWITTER_ENGAGEMENT_RATE", "-TWITTER_IMPRESSIONS", "-TWITTER_URL_CLICKS", "-TWITTER_USER_PROFILE_CLICKS", "-TWITTER_QUOTE_TWEETS", "-TWITTER_REPLIES", "-TWITTER_RETWEETS", "-TWITTER_TOTAL_ENGAGEMENTS", "-TWITTER_TOTAL_RETWEETS", "-TWITTER_FOLLOWS", "-TWITTER_VIDEO_VIEWS", "-TIKTOK_REACH", "-TIKTOK_AVERAGE_TIME_WATCHED", "-TIKTOK_AVERAGE_COMPLETION_RATE", "-TIKTOK_COMMENTS", "-TIKTOK_IMPRESSIONS_SEARCH_RATE", "-TIKTOK_FULL_VIDEO_WATCHED_RATE", "-TIKTOK_SHARES", "-TIKTOK_ENGAGEMENT_RATE", "-TIKTOK_ENTERTAINMENT_SCORE", "-TIKTOK_IMPRESSIONS_SOUND_RATE", "-TIKTOK_IMPRESSIONS_FOLLOW_RATE", "-TIKTOK_TOTAL_ENGAGEMENTS", "-TIKTOK_IMPRESSIONS_FOR_YOU_RATE", "-TIKTOK_TOTAL_TIME_WATCHED", "-TIKTOK_IMPRESSIONS_HASHTAG_RATE", "-TIKTOK_DURATION", "-TIKTOK_LIKES", "-TIKTOK_VIEWS", "-TIKTOK_IMPRESSIONS_PERSONAL_PROFILE_RATE", "-YOUTUBE_AVG_VIEW_PERCENTAGE", "-YOUTUBE_AVG_VIEW_DURATION", "-YOUTUBE_CARD_IMPRESSIONS", "-YOUTUBE_CARD_CLICKS", "-YOUTUBE_CARD_CLICK_RATE", "-YOUTUBE_CARD_TEASER_CLICKS", "-YOUTUBE_CARD_TEASER_CLICK_RATE", "-YOUTUBE_CARD_TEASER_IMPRESSIONS", "-YOUTUBE_COMMENTS", "-YOUTUBE_DISLIKES", "-YOUTUBE_LIKES", "-YOUTUBE_PREMIUM_VIEWS", "-YOUTUBE_EST_PREMIUM_SECONDS_WATCHED", "-YOUTUBE_SHARES", "-YOUTUBE_SUBSCRIBERS", "-YOUTUBE_ENGAGEMENTS", "-YOUTUBE_VIDEOS_ADDED_TO_PLAYLIST", "-YOUTUBE_VIEWS", "-YOUTUBE_EST_SECONDS_WATCHED", "-LINKEDIN_CLICK_THROUGH_RATE", "-LINKEDIN_CLICKS", "-LINKEDIN_COMMENTS", "-LINKEDIN_ENGAGEMENTS", "-LINKEDIN_ENGAGEMENT_RATE", "-LINKEDIN_IMPRESSIONS", "-LINKEDIN_LIKES", "-LINKEDIN_SHARES", "-LINKEDIN_UNIQUE_IMPRESSIONS", "-LINKEDIN_VIDEO_ANALYTICS_VIDEO_VIEWS", "-LINKEDIN_VIDEO_ANALYTICS_TIME_WATCHED_FOR_VIEWS", "-THREADS_ENGAGEMENTS", "-THREADS_ENGAGEMENT_RATE", "-THREADS_LIKES", "-THREADS_QUOTES", "-THREADS_REPLIES", "-THREADS_REPOSTS", "-THREADS_REPOSTS_AND_QUOTES", "-THREADS_SHARES", "-THREADS_VIEWS", "-SNAPCHAT_AVG_VIEW_TIME_SECONDS", "-SNAPCHAT_COMPLETES", "-SNAPCHAT_ENGAGEMENT_RATE", "-SNAPCHAT_ENGAGEMENTS", "-SNAPCHAT_FAVORITES", "-SNAPCHAT_INTERACTIONS", "-SNAPCHAT_REPLIES", "-SNAPCHAT_SHARES", "-SNAPCHAT_SWIPE_DOWNS", "-SNAPCHAT_SWIPE_UPS", "-SNAPCHAT_UNIQUE_SESSIONS", "-SNAPCHAT_VIEW_TIME_SECONDS", "-SNAPCHAT_VIEWERS", "-SNAPCHAT_VIEWS" ], "type": "string" } }, { "description": "Number of results to return in a single response.", "in": "query", "name": "limit", "required": false, "schema": { "default": 1000, "maximum": 1000, "minimum": 0, "type": "integer" } }, { "description": "The offset of the first result to be returned.", "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "minimum": 0, "type": "integer" } }, { "description": "A formatted datetime string in UTC.", "in": "query", "name": "start_date", "required": false, "schema": { "default": null, "example": "2019-12-01", "nullable": true, "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(Z|((\\+|-)\\d{2}:\\d{2})))?$", "type": "string" } }, { "description": "A formatted datetime string in UTC.", "in": "query", "name": "end_date", "required": false, "schema": { "default": null, "example": "2019-12-12", "nullable": true, "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(Z|((\\+|-)\\d{2}:\\d{2})))?$", "type": "string" } }, { "description": "Only return media that have products.", "in": "query", "name": "with_products_only", "required": false, "schema": { "default": false, "type": "boolean" } }, { "description": "The socket id of the requesting entity.", "in": "query", "name": "socket_id", "required": false, "schema": { "default": null, "nullable": true, "type": "string" } }, { "description": "The auth token of the socket connection.", "in": "query", "name": "token", "required": false, "schema": { "default": null, "nullable": true, "type": "string" } }, { "description": "The CSV type.", "in": "query", "name": "type", "required": true, "schema": { "type": "string" } }, { "description": "Include Custom Content in the Likeshop Media CSV.", "in": "query", "name": "include_custom_content", "required": false, "schema": { "default": true, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CSVTaskGenerated" } } }, "description": "OK" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Get a CSV file for Likeshop gallery media stats from all sources.", "tags": [ "Gallery" ] }, "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "format": "int32", "type": "integer" } } ] }, "/brands/{brand_id}/galleries/likeshop/order": { "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "format": "int32", "type": "integer" } } ], "patch": { "requestBody": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/GalleryOrderRequest" }, "type": "array" } } }, "required": true }, "responses": { "204": { "description": "No Content" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Change media order for regular galleries and likeshop.", "tags": [ "Gallery" ] } }, "/brands/{brand_id}/galleries/likeshop/stats": { "get": { "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Gallery" } } }, "description": "OK" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Retrieve Instagram LikeShop statistics", "tags": [ "Gallery" ], "x-public": true, "description": "Returns performance statistics for the Instagram LikeShop gallery." }, "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "minimum": 0, "type": "integer" } } ] }, "/brands/{brand_id}/galleries/likeshop/stats/csv": { "get": { "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GalleryStatsCSVReport" } } }, "description": "OK" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Download csv of stats for a gallery", "tags": [ "Gallery" ] }, "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "minimum": 0, "type": "integer" } } ] }, "/brands/{brand_id}/galleries/likeshop/sync_media_created_at": { "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "format": "int32", "type": "integer" } } ], "post": { "responses": { "204": { "description": "No Content" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Sync gallery media created at with media source_created_at", "tags": [ "Gallery" ] } }, "/brands/{brand_id}/galleries/likeshop/total_stats": { "get": { "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GalleryLikeshopTotalStats" } } }, "description": "OK" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Get the likeshop gallery stats for a brand.", "tags": [ "Gallery" ] }, "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "format": "int32", "type": "integer" } } ] }, "/brands/{brand_id}/galleries/media/csv": { "get": { "deprecated": true, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CSVTaskGenerated" } } }, "description": "OK" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "DEPRECATED. Use /brands//galleries/csv instead.", "tags": [ "Gallery" ] }, "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "format": "int32", "type": "integer" } } ] }, "/brands/{brand_id}/galleries/stats": { "get": { "responses": { "200": { "description": "OK" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Retrieve galleries statistics", "tags": [ "Gallery" ], "x-public": true, "description": "Returns aggregated statistics across all galleries for a brand." }, "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "format": "int32", "type": "integer" } } ] }, "/brands/{brand_id}/galleries/tiktok_likeshop": { "get": { "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Gallery" } } }, "description": "OK" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Retrieve TikTok LikeShop gallery", "tags": [ "Gallery" ], "x-public": true, "description": "Returns details for the TikTok LikeShop gallery for a brand." }, "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "format": "int32", "type": "integer" } } ] }, "/brands/{brand_id}/galleries/tiktok_likeshop/capture_email": { "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "minimum": 0, "type": "integer" } } ], "post": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LikeshopGalleryCaptureEmailRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Add a consumer email to a brand's LikeShop gallery", "tags": [ "Gallery" ] } }, "/brands/{brand_id}/galleries/tiktok_likeshop/custom_content_settings": { "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "format": "int32", "type": "integer" } } ], "patch": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LikeshopGallerySettings" } } }, "required": true }, "responses": { "204": { "description": "No Content" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Update the custom settings related to a Brand's LikeShop Gallery", "tags": [ "Gallery" ] } }, "/brands/{brand_id}/galleries/tiktok_likeshop/email_submissions": { "get": { "parameters": [ { "description": "Filter results starting from a date in UTC.", "in": "query", "name": "start_date", "required": false, "schema": { "default": null, "example": "2019-12-01", "nullable": true, "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(Z|((\\+|-)\\d{2}:\\d{2})))?$", "type": "string" } }, { "description": "Filter results ending at a date in UTC.", "in": "query", "name": "end_date", "required": false, "schema": { "default": null, "example": "2019-12-12", "nullable": true, "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(Z|((\\+|-)\\d{2}:\\d{2})))?$", "type": "string" } }, { "description": "Number of results to return in a single response.", "in": "query", "name": "limit", "required": false, "schema": { "default": 2000, "maximum": 5000, "minimum": 0, "type": "integer" } }, { "description": "The offset of the result to be returned.", "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "minimum": 0, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsumerEmailCapturedAtResponse" } } }, "description": "OK" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Retrieve a list of emails tracked from the LikeShop email capture", "tags": [ "Gallery" ] }, "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "minimum": 0, "type": "integer" } } ] }, "/brands/{brand_id}/galleries/tiktok_likeshop/email_submissions/csv": { "get": { "parameters": [ { "description": "The socket id of the requesting entity.", "in": "query", "name": "socket_id", "required": true, "schema": { "type": "string" } }, { "description": "Filter results starting from a date.", "in": "query", "name": "start_date", "required": false, "schema": { "default": null, "nullable": true, "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(Z|((\\+|-)\\d{2}:\\d{2})))?$", "type": "string" } }, { "description": "Filter results ending at a date.", "in": "query", "name": "end_date", "required": false, "schema": { "default": null, "nullable": true, "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(Z|((\\+|-)\\d{2}:\\d{2})))?$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CSVTaskGenerated" } } }, "description": "OK" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Generate a CSV of email submissions for a brand's LikeShop gallery", "tags": [ "Gallery" ] }, "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "minimum": 0, "type": "integer" } } ] }, "/brands/{brand_id}/galleries/tiktok_likeshop/gallery_media_products/csv": { "get": { "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CSVTaskGenerated" } } }, "description": "OK" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Produce a CSV of LikeShop gallery media grouped by product URLs", "tags": [ "Gallery" ] }, "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "format": "int32", "type": "integer" } } ] }, "/brands/{brand_id}/galleries/tiktok_likeshop/media": { "get": { "parameters": [ { "description": "Sort by field. \"-\" for descending.", "in": "query", "name": "sort", "required": false, "schema": { "enum": [ "PUBLISHED_AT", "CREATED", "UPDATED", "ORDER", "VISITS", "ADDED", "POSTED", "CLICKS", "LIKESHOP_CLICKS", "PERFORMANCE", "VIDEO_VIEWS", "AVERAGE_VIDEO_WATCH_TIME", "INSTAGRAM_EFFECTIVENESS", "INSTAGRAM_REACH", "INSTAGRAM_ENGAGEMENT", "INSTAGRAM_ORGANIC_COMMENTS", "INSTAGRAM_PAID_COMMENTS", "INSTAGRAM_TOTAL_COMMENTS", "INSTAGRAM_ENGAGEMENT_RATE", "INSTAGRAM_ENGAGEMENT_RATE_VIEWS", "INSTAGRAM_ORGANIC_IMPRESSIONS", "INSTAGRAM_PAID_IMPRESSIONS", "INSTAGRAM_TOTAL_IMPRESSIONS", "INSTAGRAM_ORGANIC_LIKES", "INSTAGRAM_PAID_LIKES", "INSTAGRAM_TOTAL_LIKES", "INSTAGRAM_SAVES", "INSTAGRAM_TOTAL_ENGAGEMENTS", "INSTAGRAM_PAID_TOTAL_ENGAGEMENTS", "INSTAGRAM_SUM_TOTAL_ENGAGEMENTS", "INSTAGRAM_VIDEO_VIEWS", "INSTAGRAM_PAID_VIDEO_VIEWS", "INSTAGRAM_TOTAL_VIDEO_VIEWS", "INSTAGRAM_PAID_ENGAGEMENT_RATE", "INSTAGRAM_TOTAL_WATCH_TIME", "INSTAGRAM_STORY_REACH", "INSTAGRAM_STORY_IMPRESSIONS", "INSTAGRAM_STORY_SWIPE_UPS", "INSTAGRAM_STORY_REPLIES", "INSTAGRAM_STORY_EXIT_RATE", "PINTEREST_CLICKS", "PINTEREST_CLOSEUPS", "PINTEREST_COMMENTS", "PINTEREST_ENGAGEMENT", "PINTEREST_IMPRESSIONS", "PINTEREST_SAVES", "PINTEREST_VIDEO_VIEWS", "PINTEREST_AVERAGE_VIDEO_WATCH_TIME", "PINTEREST_ENGAGEMENTS", "DATE", "INSTAGRAM_STORY_FRAME_REACH", "INSTAGRAM_STORY_FRAME_IMPRESSIONS", "INSTAGRAM_STORY_FRAME_COMPLETION_RATE", "INSTAGRAM_STORY_FRAME_EXITS", "INSTAGRAM_STORY_FRAME_EXIT_RATE", "INSTAGRAM_STORY_FRAME_SWIPE_UPS", "INSTAGRAM_STORY_FRAME_REPLIES", "INSTAGRAM_STORY_FRAME_TAPS_BACK", "INSTAGRAM_STORY_FRAME_TAPS_FORWARD", "FACEBOOK_PHOTO_VIEW_CLICKS", "FACEBOOK_POST_CLICKS", "FACEBOOK_COMMENTS", "FACEBOOK_REACH", "FACEBOOK_EFFECTIVENESS", "FACEBOOK_REACTIONS", "FACEBOOK_ENGAGEMENT_RATE", "FACEBOOK_ENGAGEMENT_RATE_PUBLIC", "FACEBOOK_SHARES", "FACEBOOK_IMPRESSIONS", "FACEBOOK_TOTAL_ENGAGEMENTS", "FACEBOOK_TOTAL_ENGAGEMENTS_PUBLIC", "FACEBOOK_LINK_CLICKS", "FACEBOOK_VIDEO_COMPLETE_VIEWS", "FACEBOOK_OTHER_CLICKS", "FACEBOOK_VIDEO_VIEWS", "FACEBOOK_REELS_POST_VIDEO_VIEW_TIME", "FACEBOOK_REELS_POST_IMPRESSIONS_UNIQUE", "TWITTER_ENGAGEMENT_RATE", "TWITTER_IMPRESSIONS", "TWITTER_URL_CLICKS", "TWITTER_USER_PROFILE_CLICKS", "TWITTER_QUOTE_TWEETS", "TWITTER_REPLIES", "TWITTER_RETWEETS", "TWITTER_TOTAL_ENGAGEMENTS", "TWITTER_TOTAL_RETWEETS", "TWITTER_FOLLOWS", "TWITTER_VIDEO_VIEWS", "TIKTOK_REACH", "TIKTOK_AVERAGE_TIME_WATCHED", "TIKTOK_AVERAGE_COMPLETION_RATE", "TIKTOK_COMMENTS", "TIKTOK_IMPRESSIONS_SEARCH_RATE", "TIKTOK_FULL_VIDEO_WATCHED_RATE", "TIKTOK_SHARES", "TIKTOK_ENGAGEMENT_RATE", "TIKTOK_ENTERTAINMENT_SCORE", "TIKTOK_IMPRESSIONS_SOUND_RATE", "TIKTOK_IMPRESSIONS_FOLLOW_RATE", "TIKTOK_TOTAL_ENGAGEMENTS", "TIKTOK_IMPRESSIONS_FOR_YOU_RATE", "TIKTOK_TOTAL_TIME_WATCHED", "TIKTOK_IMPRESSIONS_HASHTAG_RATE", "TIKTOK_DURATION", "TIKTOK_LIKES", "TIKTOK_VIEWS", "TIKTOK_IMPRESSIONS_PERSONAL_PROFILE_RATE", "YOUTUBE_AVG_VIEW_PERCENTAGE", "YOUTUBE_AVG_VIEW_DURATION", "YOUTUBE_CARD_IMPRESSIONS", "YOUTUBE_CARD_CLICKS", "YOUTUBE_CARD_CLICK_RATE", "YOUTUBE_CARD_TEASER_CLICKS", "YOUTUBE_CARD_TEASER_CLICK_RATE", "YOUTUBE_CARD_TEASER_IMPRESSIONS", "YOUTUBE_COMMENTS", "YOUTUBE_DISLIKES", "YOUTUBE_LIKES", "YOUTUBE_PREMIUM_VIEWS", "YOUTUBE_EST_PREMIUM_SECONDS_WATCHED", "YOUTUBE_SHARES", "YOUTUBE_SUBSCRIBERS", "YOUTUBE_ENGAGEMENTS", "YOUTUBE_VIDEOS_ADDED_TO_PLAYLIST", "YOUTUBE_VIEWS", "YOUTUBE_EST_SECONDS_WATCHED", "LINKEDIN_CLICK_THROUGH_RATE", "LINKEDIN_CLICKS", "LINKEDIN_COMMENTS", "LINKEDIN_ENGAGEMENTS", "LINKEDIN_ENGAGEMENT_RATE", "LINKEDIN_IMPRESSIONS", "LINKEDIN_LIKES", "LINKEDIN_SHARES", "LINKEDIN_UNIQUE_IMPRESSIONS", "LINKEDIN_VIDEO_ANALYTICS_VIDEO_VIEWS", "LINKEDIN_VIDEO_ANALYTICS_TIME_WATCHED_FOR_VIEWS", "THREADS_ENGAGEMENTS", "THREADS_ENGAGEMENT_RATE", "THREADS_LIKES", "THREADS_QUOTES", "THREADS_REPLIES", "THREADS_REPOSTS", "THREADS_REPOSTS_AND_QUOTES", "THREADS_SHARES", "THREADS_VIEWS", "SNAPCHAT_AVG_VIEW_TIME_SECONDS", "SNAPCHAT_COMPLETES", "SNAPCHAT_ENGAGEMENT_RATE", "SNAPCHAT_ENGAGEMENTS", "SNAPCHAT_FAVORITES", "SNAPCHAT_INTERACTIONS", "SNAPCHAT_REPLIES", "SNAPCHAT_SHARES", "SNAPCHAT_SWIPE_DOWNS", "SNAPCHAT_SWIPE_UPS", "SNAPCHAT_UNIQUE_SESSIONS", "SNAPCHAT_VIEW_TIME_SECONDS", "SNAPCHAT_VIEWERS", "SNAPCHAT_VIEWS", "-PUBLISHED_AT", "-CREATED", "-UPDATED", "-ORDER", "-VISITS", "-ADDED", "-POSTED", "-CLICKS", "-LIKESHOP_CLICKS", "-PERFORMANCE", "-VIDEO_VIEWS", "-AVERAGE_VIDEO_WATCH_TIME", "-INSTAGRAM_EFFECTIVENESS", "-INSTAGRAM_REACH", "-INSTAGRAM_ENGAGEMENT", "-INSTAGRAM_ORGANIC_COMMENTS", "-INSTAGRAM_PAID_COMMENTS", "-INSTAGRAM_TOTAL_COMMENTS", "-INSTAGRAM_ENGAGEMENT_RATE", "-INSTAGRAM_ENGAGEMENT_RATE_VIEWS", "-INSTAGRAM_ORGANIC_IMPRESSIONS", "-INSTAGRAM_PAID_IMPRESSIONS", "-INSTAGRAM_TOTAL_IMPRESSIONS", "-INSTAGRAM_ORGANIC_LIKES", "-INSTAGRAM_PAID_LIKES", "-INSTAGRAM_TOTAL_LIKES", "-INSTAGRAM_SAVES", "-INSTAGRAM_TOTAL_ENGAGEMENTS", "-INSTAGRAM_PAID_TOTAL_ENGAGEMENTS", "-INSTAGRAM_SUM_TOTAL_ENGAGEMENTS", "-INSTAGRAM_VIDEO_VIEWS", "-INSTAGRAM_PAID_VIDEO_VIEWS", "-INSTAGRAM_TOTAL_VIDEO_VIEWS", "-INSTAGRAM_PAID_ENGAGEMENT_RATE", "-INSTAGRAM_TOTAL_WATCH_TIME", "-INSTAGRAM_STORY_REACH", "-INSTAGRAM_STORY_IMPRESSIONS", "-INSTAGRAM_STORY_SWIPE_UPS", "-INSTAGRAM_STORY_REPLIES", "-INSTAGRAM_STORY_EXIT_RATE", "-PINTEREST_CLICKS", "-PINTEREST_CLOSEUPS", "-PINTEREST_COMMENTS", "-PINTEREST_ENGAGEMENT", "-PINTEREST_IMPRESSIONS", "-PINTEREST_SAVES", "-PINTEREST_VIDEO_VIEWS", "-PINTEREST_AVERAGE_VIDEO_WATCH_TIME", "-PINTEREST_ENGAGEMENTS", "-DATE", "-INSTAGRAM_STORY_FRAME_REACH", "-INSTAGRAM_STORY_FRAME_IMPRESSIONS", "-INSTAGRAM_STORY_FRAME_COMPLETION_RATE", "-INSTAGRAM_STORY_FRAME_EXITS", "-INSTAGRAM_STORY_FRAME_EXIT_RATE", "-INSTAGRAM_STORY_FRAME_SWIPE_UPS", "-INSTAGRAM_STORY_FRAME_REPLIES", "-INSTAGRAM_STORY_FRAME_TAPS_BACK", "-INSTAGRAM_STORY_FRAME_TAPS_FORWARD", "-FACEBOOK_PHOTO_VIEW_CLICKS", "-FACEBOOK_POST_CLICKS", "-FACEBOOK_COMMENTS", "-FACEBOOK_REACH", "-FACEBOOK_EFFECTIVENESS", "-FACEBOOK_REACTIONS", "-FACEBOOK_ENGAGEMENT_RATE", "-FACEBOOK_ENGAGEMENT_RATE_PUBLIC", "-FACEBOOK_SHARES", "-FACEBOOK_IMPRESSIONS", "-FACEBOOK_TOTAL_ENGAGEMENTS", "-FACEBOOK_TOTAL_ENGAGEMENTS_PUBLIC", "-FACEBOOK_LINK_CLICKS", "-FACEBOOK_VIDEO_COMPLETE_VIEWS", "-FACEBOOK_OTHER_CLICKS", "-FACEBOOK_VIDEO_VIEWS", "-FACEBOOK_REELS_POST_VIDEO_VIEW_TIME", "-FACEBOOK_REELS_POST_IMPRESSIONS_UNIQUE", "-TWITTER_ENGAGEMENT_RATE", "-TWITTER_IMPRESSIONS", "-TWITTER_URL_CLICKS", "-TWITTER_USER_PROFILE_CLICKS", "-TWITTER_QUOTE_TWEETS", "-TWITTER_REPLIES", "-TWITTER_RETWEETS", "-TWITTER_TOTAL_ENGAGEMENTS", "-TWITTER_TOTAL_RETWEETS", "-TWITTER_FOLLOWS", "-TWITTER_VIDEO_VIEWS", "-TIKTOK_REACH", "-TIKTOK_AVERAGE_TIME_WATCHED", "-TIKTOK_AVERAGE_COMPLETION_RATE", "-TIKTOK_COMMENTS", "-TIKTOK_IMPRESSIONS_SEARCH_RATE", "-TIKTOK_FULL_VIDEO_WATCHED_RATE", "-TIKTOK_SHARES", "-TIKTOK_ENGAGEMENT_RATE", "-TIKTOK_ENTERTAINMENT_SCORE", "-TIKTOK_IMPRESSIONS_SOUND_RATE", "-TIKTOK_IMPRESSIONS_FOLLOW_RATE", "-TIKTOK_TOTAL_ENGAGEMENTS", "-TIKTOK_IMPRESSIONS_FOR_YOU_RATE", "-TIKTOK_TOTAL_TIME_WATCHED", "-TIKTOK_IMPRESSIONS_HASHTAG_RATE", "-TIKTOK_DURATION", "-TIKTOK_LIKES", "-TIKTOK_VIEWS", "-TIKTOK_IMPRESSIONS_PERSONAL_PROFILE_RATE", "-YOUTUBE_AVG_VIEW_PERCENTAGE", "-YOUTUBE_AVG_VIEW_DURATION", "-YOUTUBE_CARD_IMPRESSIONS", "-YOUTUBE_CARD_CLICKS", "-YOUTUBE_CARD_CLICK_RATE", "-YOUTUBE_CARD_TEASER_CLICKS", "-YOUTUBE_CARD_TEASER_CLICK_RATE", "-YOUTUBE_CARD_TEASER_IMPRESSIONS", "-YOUTUBE_COMMENTS", "-YOUTUBE_DISLIKES", "-YOUTUBE_LIKES", "-YOUTUBE_PREMIUM_VIEWS", "-YOUTUBE_EST_PREMIUM_SECONDS_WATCHED", "-YOUTUBE_SHARES", "-YOUTUBE_SUBSCRIBERS", "-YOUTUBE_ENGAGEMENTS", "-YOUTUBE_VIDEOS_ADDED_TO_PLAYLIST", "-YOUTUBE_VIEWS", "-YOUTUBE_EST_SECONDS_WATCHED", "-LINKEDIN_CLICK_THROUGH_RATE", "-LINKEDIN_CLICKS", "-LINKEDIN_COMMENTS", "-LINKEDIN_ENGAGEMENTS", "-LINKEDIN_ENGAGEMENT_RATE", "-LINKEDIN_IMPRESSIONS", "-LINKEDIN_LIKES", "-LINKEDIN_SHARES", "-LINKEDIN_UNIQUE_IMPRESSIONS", "-LINKEDIN_VIDEO_ANALYTICS_VIDEO_VIEWS", "-LINKEDIN_VIDEO_ANALYTICS_TIME_WATCHED_FOR_VIEWS", "-THREADS_ENGAGEMENTS", "-THREADS_ENGAGEMENT_RATE", "-THREADS_LIKES", "-THREADS_QUOTES", "-THREADS_REPLIES", "-THREADS_REPOSTS", "-THREADS_REPOSTS_AND_QUOTES", "-THREADS_SHARES", "-THREADS_VIEWS", "-SNAPCHAT_AVG_VIEW_TIME_SECONDS", "-SNAPCHAT_COMPLETES", "-SNAPCHAT_ENGAGEMENT_RATE", "-SNAPCHAT_ENGAGEMENTS", "-SNAPCHAT_FAVORITES", "-SNAPCHAT_INTERACTIONS", "-SNAPCHAT_REPLIES", "-SNAPCHAT_SHARES", "-SNAPCHAT_SWIPE_DOWNS", "-SNAPCHAT_SWIPE_UPS", "-SNAPCHAT_UNIQUE_SESSIONS", "-SNAPCHAT_VIEW_TIME_SECONDS", "-SNAPCHAT_VIEWERS", "-SNAPCHAT_VIEWS" ], "type": "string" } }, { "description": "Number of results to return in a single response.", "in": "query", "name": "limit", "required": false, "schema": { "default": 100, "maximum": 1000, "minimum": 1, "type": "integer" } }, { "description": "The offset of the first result to be returned.", "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "minimum": 0, "type": "integer" } }, { "description": "A formatted datetime string in UTC.", "in": "query", "name": "start_date", "required": false, "schema": { "default": null, "example": "2019-12-01", "nullable": true, "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(Z|((\\+|-)\\d{2}:\\d{2})))?$", "type": "string" } }, { "description": "A formatted datetime string in UTC.", "in": "query", "name": "end_date", "required": false, "schema": { "default": null, "example": "2019-12-12", "nullable": true, "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(Z|((\\+|-)\\d{2}:\\d{2})))?$", "type": "string" } }, { "description": "Only return media that have products.", "in": "query", "name": "with_products_only", "required": false, "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GalleryMediaList" } } }, "description": "OK" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "tags": [ "Gallery" ], "x-public": true, "summary": "Retrieve TikTok LikeShop media", "description": "Returns media items in the TikTok LikeShop gallery." }, "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "minimum": 0, "type": "integer" } } ] }, "/brands/{brand_id}/galleries/tiktok_likeshop/media/csv": { "get": { "parameters": [ { "description": "Sort by field. \"-\" for descending.", "in": "query", "name": "sort", "required": false, "schema": { "enum": [ "PUBLISHED_AT", "CREATED", "UPDATED", "ORDER", "VISITS", "ADDED", "POSTED", "CLICKS", "LIKESHOP_CLICKS", "PERFORMANCE", "VIDEO_VIEWS", "AVERAGE_VIDEO_WATCH_TIME", "INSTAGRAM_EFFECTIVENESS", "INSTAGRAM_REACH", "INSTAGRAM_ENGAGEMENT", "INSTAGRAM_ORGANIC_COMMENTS", "INSTAGRAM_PAID_COMMENTS", "INSTAGRAM_TOTAL_COMMENTS", "INSTAGRAM_ENGAGEMENT_RATE", "INSTAGRAM_ENGAGEMENT_RATE_VIEWS", "INSTAGRAM_ORGANIC_IMPRESSIONS", "INSTAGRAM_PAID_IMPRESSIONS", "INSTAGRAM_TOTAL_IMPRESSIONS", "INSTAGRAM_ORGANIC_LIKES", "INSTAGRAM_PAID_LIKES", "INSTAGRAM_TOTAL_LIKES", "INSTAGRAM_SAVES", "INSTAGRAM_TOTAL_ENGAGEMENTS", "INSTAGRAM_PAID_TOTAL_ENGAGEMENTS", "INSTAGRAM_SUM_TOTAL_ENGAGEMENTS", "INSTAGRAM_VIDEO_VIEWS", "INSTAGRAM_PAID_VIDEO_VIEWS", "INSTAGRAM_TOTAL_VIDEO_VIEWS", "INSTAGRAM_PAID_ENGAGEMENT_RATE", "INSTAGRAM_TOTAL_WATCH_TIME", "INSTAGRAM_STORY_REACH", "INSTAGRAM_STORY_IMPRESSIONS", "INSTAGRAM_STORY_SWIPE_UPS", "INSTAGRAM_STORY_REPLIES", "INSTAGRAM_STORY_EXIT_RATE", "PINTEREST_CLICKS", "PINTEREST_CLOSEUPS", "PINTEREST_COMMENTS", "PINTEREST_ENGAGEMENT", "PINTEREST_IMPRESSIONS", "PINTEREST_SAVES", "PINTEREST_VIDEO_VIEWS", "PINTEREST_AVERAGE_VIDEO_WATCH_TIME", "PINTEREST_ENGAGEMENTS", "DATE", "INSTAGRAM_STORY_FRAME_REACH", "INSTAGRAM_STORY_FRAME_IMPRESSIONS", "INSTAGRAM_STORY_FRAME_COMPLETION_RATE", "INSTAGRAM_STORY_FRAME_EXITS", "INSTAGRAM_STORY_FRAME_EXIT_RATE", "INSTAGRAM_STORY_FRAME_SWIPE_UPS", "INSTAGRAM_STORY_FRAME_REPLIES", "INSTAGRAM_STORY_FRAME_TAPS_BACK", "INSTAGRAM_STORY_FRAME_TAPS_FORWARD", "FACEBOOK_PHOTO_VIEW_CLICKS", "FACEBOOK_POST_CLICKS", "FACEBOOK_COMMENTS", "FACEBOOK_REACH", "FACEBOOK_EFFECTIVENESS", "FACEBOOK_REACTIONS", "FACEBOOK_ENGAGEMENT_RATE", "FACEBOOK_ENGAGEMENT_RATE_PUBLIC", "FACEBOOK_SHARES", "FACEBOOK_IMPRESSIONS", "FACEBOOK_TOTAL_ENGAGEMENTS", "FACEBOOK_TOTAL_ENGAGEMENTS_PUBLIC", "FACEBOOK_LINK_CLICKS", "FACEBOOK_VIDEO_COMPLETE_VIEWS", "FACEBOOK_OTHER_CLICKS", "FACEBOOK_VIDEO_VIEWS", "FACEBOOK_REELS_POST_VIDEO_VIEW_TIME", "FACEBOOK_REELS_POST_IMPRESSIONS_UNIQUE", "TWITTER_ENGAGEMENT_RATE", "TWITTER_IMPRESSIONS", "TWITTER_URL_CLICKS", "TWITTER_USER_PROFILE_CLICKS", "TWITTER_QUOTE_TWEETS", "TWITTER_REPLIES", "TWITTER_RETWEETS", "TWITTER_TOTAL_ENGAGEMENTS", "TWITTER_TOTAL_RETWEETS", "TWITTER_FOLLOWS", "TWITTER_VIDEO_VIEWS", "TIKTOK_REACH", "TIKTOK_AVERAGE_TIME_WATCHED", "TIKTOK_AVERAGE_COMPLETION_RATE", "TIKTOK_COMMENTS", "TIKTOK_IMPRESSIONS_SEARCH_RATE", "TIKTOK_FULL_VIDEO_WATCHED_RATE", "TIKTOK_SHARES", "TIKTOK_ENGAGEMENT_RATE", "TIKTOK_ENTERTAINMENT_SCORE", "TIKTOK_IMPRESSIONS_SOUND_RATE", "TIKTOK_IMPRESSIONS_FOLLOW_RATE", "TIKTOK_TOTAL_ENGAGEMENTS", "TIKTOK_IMPRESSIONS_FOR_YOU_RATE", "TIKTOK_TOTAL_TIME_WATCHED", "TIKTOK_IMPRESSIONS_HASHTAG_RATE", "TIKTOK_DURATION", "TIKTOK_LIKES", "TIKTOK_VIEWS", "TIKTOK_IMPRESSIONS_PERSONAL_PROFILE_RATE", "YOUTUBE_AVG_VIEW_PERCENTAGE", "YOUTUBE_AVG_VIEW_DURATION", "YOUTUBE_CARD_IMPRESSIONS", "YOUTUBE_CARD_CLICKS", "YOUTUBE_CARD_CLICK_RATE", "YOUTUBE_CARD_TEASER_CLICKS", "YOUTUBE_CARD_TEASER_CLICK_RATE", "YOUTUBE_CARD_TEASER_IMPRESSIONS", "YOUTUBE_COMMENTS", "YOUTUBE_DISLIKES", "YOUTUBE_LIKES", "YOUTUBE_PREMIUM_VIEWS", "YOUTUBE_EST_PREMIUM_SECONDS_WATCHED", "YOUTUBE_SHARES", "YOUTUBE_SUBSCRIBERS", "YOUTUBE_ENGAGEMENTS", "YOUTUBE_VIDEOS_ADDED_TO_PLAYLIST", "YOUTUBE_VIEWS", "YOUTUBE_EST_SECONDS_WATCHED", "LINKEDIN_CLICK_THROUGH_RATE", "LINKEDIN_CLICKS", "LINKEDIN_COMMENTS", "LINKEDIN_ENGAGEMENTS", "LINKEDIN_ENGAGEMENT_RATE", "LINKEDIN_IMPRESSIONS", "LINKEDIN_LIKES", "LINKEDIN_SHARES", "LINKEDIN_UNIQUE_IMPRESSIONS", "LINKEDIN_VIDEO_ANALYTICS_VIDEO_VIEWS", "LINKEDIN_VIDEO_ANALYTICS_TIME_WATCHED_FOR_VIEWS", "THREADS_ENGAGEMENTS", "THREADS_ENGAGEMENT_RATE", "THREADS_LIKES", "THREADS_QUOTES", "THREADS_REPLIES", "THREADS_REPOSTS", "THREADS_REPOSTS_AND_QUOTES", "THREADS_SHARES", "THREADS_VIEWS", "SNAPCHAT_AVG_VIEW_TIME_SECONDS", "SNAPCHAT_COMPLETES", "SNAPCHAT_ENGAGEMENT_RATE", "SNAPCHAT_ENGAGEMENTS", "SNAPCHAT_FAVORITES", "SNAPCHAT_INTERACTIONS", "SNAPCHAT_REPLIES", "SNAPCHAT_SHARES", "SNAPCHAT_SWIPE_DOWNS", "SNAPCHAT_SWIPE_UPS", "SNAPCHAT_UNIQUE_SESSIONS", "SNAPCHAT_VIEW_TIME_SECONDS", "SNAPCHAT_VIEWERS", "SNAPCHAT_VIEWS", "-PUBLISHED_AT", "-CREATED", "-UPDATED", "-ORDER", "-VISITS", "-ADDED", "-POSTED", "-CLICKS", "-LIKESHOP_CLICKS", "-PERFORMANCE", "-VIDEO_VIEWS", "-AVERAGE_VIDEO_WATCH_TIME", "-INSTAGRAM_EFFECTIVENESS", "-INSTAGRAM_REACH", "-INSTAGRAM_ENGAGEMENT", "-INSTAGRAM_ORGANIC_COMMENTS", "-INSTAGRAM_PAID_COMMENTS", "-INSTAGRAM_TOTAL_COMMENTS", "-INSTAGRAM_ENGAGEMENT_RATE", "-INSTAGRAM_ENGAGEMENT_RATE_VIEWS", "-INSTAGRAM_ORGANIC_IMPRESSIONS", "-INSTAGRAM_PAID_IMPRESSIONS", "-INSTAGRAM_TOTAL_IMPRESSIONS", "-INSTAGRAM_ORGANIC_LIKES", "-INSTAGRAM_PAID_LIKES", "-INSTAGRAM_TOTAL_LIKES", "-INSTAGRAM_SAVES", "-INSTAGRAM_TOTAL_ENGAGEMENTS", "-INSTAGRAM_PAID_TOTAL_ENGAGEMENTS", "-INSTAGRAM_SUM_TOTAL_ENGAGEMENTS", "-INSTAGRAM_VIDEO_VIEWS", "-INSTAGRAM_PAID_VIDEO_VIEWS", "-INSTAGRAM_TOTAL_VIDEO_VIEWS", "-INSTAGRAM_PAID_ENGAGEMENT_RATE", "-INSTAGRAM_TOTAL_WATCH_TIME", "-INSTAGRAM_STORY_REACH", "-INSTAGRAM_STORY_IMPRESSIONS", "-INSTAGRAM_STORY_SWIPE_UPS", "-INSTAGRAM_STORY_REPLIES", "-INSTAGRAM_STORY_EXIT_RATE", "-PINTEREST_CLICKS", "-PINTEREST_CLOSEUPS", "-PINTEREST_COMMENTS", "-PINTEREST_ENGAGEMENT", "-PINTEREST_IMPRESSIONS", "-PINTEREST_SAVES", "-PINTEREST_VIDEO_VIEWS", "-PINTEREST_AVERAGE_VIDEO_WATCH_TIME", "-PINTEREST_ENGAGEMENTS", "-DATE", "-INSTAGRAM_STORY_FRAME_REACH", "-INSTAGRAM_STORY_FRAME_IMPRESSIONS", "-INSTAGRAM_STORY_FRAME_COMPLETION_RATE", "-INSTAGRAM_STORY_FRAME_EXITS", "-INSTAGRAM_STORY_FRAME_EXIT_RATE", "-INSTAGRAM_STORY_FRAME_SWIPE_UPS", "-INSTAGRAM_STORY_FRAME_REPLIES", "-INSTAGRAM_STORY_FRAME_TAPS_BACK", "-INSTAGRAM_STORY_FRAME_TAPS_FORWARD", "-FACEBOOK_PHOTO_VIEW_CLICKS", "-FACEBOOK_POST_CLICKS", "-FACEBOOK_COMMENTS", "-FACEBOOK_REACH", "-FACEBOOK_EFFECTIVENESS", "-FACEBOOK_REACTIONS", "-FACEBOOK_ENGAGEMENT_RATE", "-FACEBOOK_ENGAGEMENT_RATE_PUBLIC", "-FACEBOOK_SHARES", "-FACEBOOK_IMPRESSIONS", "-FACEBOOK_TOTAL_ENGAGEMENTS", "-FACEBOOK_TOTAL_ENGAGEMENTS_PUBLIC", "-FACEBOOK_LINK_CLICKS", "-FACEBOOK_VIDEO_COMPLETE_VIEWS", "-FACEBOOK_OTHER_CLICKS", "-FACEBOOK_VIDEO_VIEWS", "-FACEBOOK_REELS_POST_VIDEO_VIEW_TIME", "-FACEBOOK_REELS_POST_IMPRESSIONS_UNIQUE", "-TWITTER_ENGAGEMENT_RATE", "-TWITTER_IMPRESSIONS", "-TWITTER_URL_CLICKS", "-TWITTER_USER_PROFILE_CLICKS", "-TWITTER_QUOTE_TWEETS", "-TWITTER_REPLIES", "-TWITTER_RETWEETS", "-TWITTER_TOTAL_ENGAGEMENTS", "-TWITTER_TOTAL_RETWEETS", "-TWITTER_FOLLOWS", "-TWITTER_VIDEO_VIEWS", "-TIKTOK_REACH", "-TIKTOK_AVERAGE_TIME_WATCHED", "-TIKTOK_AVERAGE_COMPLETION_RATE", "-TIKTOK_COMMENTS", "-TIKTOK_IMPRESSIONS_SEARCH_RATE", "-TIKTOK_FULL_VIDEO_WATCHED_RATE", "-TIKTOK_SHARES", "-TIKTOK_ENGAGEMENT_RATE", "-TIKTOK_ENTERTAINMENT_SCORE", "-TIKTOK_IMPRESSIONS_SOUND_RATE", "-TIKTOK_IMPRESSIONS_FOLLOW_RATE", "-TIKTOK_TOTAL_ENGAGEMENTS", "-TIKTOK_IMPRESSIONS_FOR_YOU_RATE", "-TIKTOK_TOTAL_TIME_WATCHED", "-TIKTOK_IMPRESSIONS_HASHTAG_RATE", "-TIKTOK_DURATION", "-TIKTOK_LIKES", "-TIKTOK_VIEWS", "-TIKTOK_IMPRESSIONS_PERSONAL_PROFILE_RATE", "-YOUTUBE_AVG_VIEW_PERCENTAGE", "-YOUTUBE_AVG_VIEW_DURATION", "-YOUTUBE_CARD_IMPRESSIONS", "-YOUTUBE_CARD_CLICKS", "-YOUTUBE_CARD_CLICK_RATE", "-YOUTUBE_CARD_TEASER_CLICKS", "-YOUTUBE_CARD_TEASER_CLICK_RATE", "-YOUTUBE_CARD_TEASER_IMPRESSIONS", "-YOUTUBE_COMMENTS", "-YOUTUBE_DISLIKES", "-YOUTUBE_LIKES", "-YOUTUBE_PREMIUM_VIEWS", "-YOUTUBE_EST_PREMIUM_SECONDS_WATCHED", "-YOUTUBE_SHARES", "-YOUTUBE_SUBSCRIBERS", "-YOUTUBE_ENGAGEMENTS", "-YOUTUBE_VIDEOS_ADDED_TO_PLAYLIST", "-YOUTUBE_VIEWS", "-YOUTUBE_EST_SECONDS_WATCHED", "-LINKEDIN_CLICK_THROUGH_RATE", "-LINKEDIN_CLICKS", "-LINKEDIN_COMMENTS", "-LINKEDIN_ENGAGEMENTS", "-LINKEDIN_ENGAGEMENT_RATE", "-LINKEDIN_IMPRESSIONS", "-LINKEDIN_LIKES", "-LINKEDIN_SHARES", "-LINKEDIN_UNIQUE_IMPRESSIONS", "-LINKEDIN_VIDEO_ANALYTICS_VIDEO_VIEWS", "-LINKEDIN_VIDEO_ANALYTICS_TIME_WATCHED_FOR_VIEWS", "-THREADS_ENGAGEMENTS", "-THREADS_ENGAGEMENT_RATE", "-THREADS_LIKES", "-THREADS_QUOTES", "-THREADS_REPLIES", "-THREADS_REPOSTS", "-THREADS_REPOSTS_AND_QUOTES", "-THREADS_SHARES", "-THREADS_VIEWS", "-SNAPCHAT_AVG_VIEW_TIME_SECONDS", "-SNAPCHAT_COMPLETES", "-SNAPCHAT_ENGAGEMENT_RATE", "-SNAPCHAT_ENGAGEMENTS", "-SNAPCHAT_FAVORITES", "-SNAPCHAT_INTERACTIONS", "-SNAPCHAT_REPLIES", "-SNAPCHAT_SHARES", "-SNAPCHAT_SWIPE_DOWNS", "-SNAPCHAT_SWIPE_UPS", "-SNAPCHAT_UNIQUE_SESSIONS", "-SNAPCHAT_VIEW_TIME_SECONDS", "-SNAPCHAT_VIEWERS", "-SNAPCHAT_VIEWS" ], "type": "string" } }, { "description": "Number of results to return in a single response.", "in": "query", "name": "limit", "required": false, "schema": { "default": 1000, "maximum": 1000, "minimum": 0, "type": "integer" } }, { "description": "The offset of the first result to be returned.", "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "minimum": 0, "type": "integer" } }, { "description": "A formatted datetime string in UTC.", "in": "query", "name": "start_date", "required": false, "schema": { "default": null, "example": "2019-12-01", "nullable": true, "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(Z|((\\+|-)\\d{2}:\\d{2})))?$", "type": "string" } }, { "description": "A formatted datetime string in UTC.", "in": "query", "name": "end_date", "required": false, "schema": { "default": null, "example": "2019-12-12", "nullable": true, "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(Z|((\\+|-)\\d{2}:\\d{2})))?$", "type": "string" } }, { "description": "Only return media that have products.", "in": "query", "name": "with_products_only", "required": false, "schema": { "default": false, "type": "boolean" } }, { "description": "The socket id of the requesting entity.", "in": "query", "name": "socket_id", "required": false, "schema": { "default": null, "nullable": true, "type": "string" } }, { "description": "The auth token of the socket connection.", "in": "query", "name": "token", "required": false, "schema": { "default": null, "nullable": true, "type": "string" } }, { "description": "The CSV type.", "in": "query", "name": "type", "required": true, "schema": { "type": "string" } }, { "description": "Include Custom Content in the Likeshop Media CSV.", "in": "query", "name": "include_custom_content", "required": false, "schema": { "default": true, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CSVTaskGenerated" } } }, "description": "OK" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Get a CSV file for TikTok LikeShop gallery media stats.", "tags": [ "Gallery" ] }, "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "format": "int32", "type": "integer" } } ] }, "/brands/{brand_id}/galleries/tiktok_likeshop/stats/csv": { "get": { "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GalleryStatsCSVReport" } } }, "description": "OK" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Download csv of stats for a gallery", "tags": [ "Gallery" ] }, "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "minimum": 0, "type": "integer" } } ] }, "/brands/{brand_id}/galleries/timeseries_metrics/csv": { "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "format": "int32", "type": "integer" } } ], "post": { "parameters": [ { "description": "The auth token of the socket connection.", "in": "query", "name": "token", "required": false, "schema": { "default": null, "nullable": true, "type": "string" } }, { "description": "The socket id of the requesting entity.", "in": "query", "name": "socket_id", "required": false, "schema": { "default": null, "nullable": true, "type": "string" } }, { "description": "Scale of aggregated metrics", "in": "query", "name": "scale", "required": true, "schema": { "enum": [ "DAILY", "MONTHLY" ], "type": "string" } }, { "description": "Start date of time range", "in": "query", "name": "start_date", "required": true, "schema": { "example": "2020-01-01", "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(Z|((\\+|-)\\d{2}:\\d{2})))?$", "type": "string" } }, { "description": "End date of time range", "in": "query", "name": "end_date", "required": true, "schema": { "example": "2020-12-31", "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(Z|((\\+|-)\\d{2}:\\d{2})))?$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CSVTaskGenerated" } } }, "description": "OK" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Start generation of galleries story metrics CSV for the given brand.", "tags": [ "Gallery" ] } }, "/brands/{brand_id}/galleries/{gallery_id}": { "delete": { "responses": { "204": { "description": "No Content" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Delete a gallery", "tags": [ "Gallery" ], "x-public": true, "description": "Permanently deletes a gallery." }, "get": { "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Gallery" } } }, "description": "OK" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Retrieve a gallery", "tags": [ "Gallery" ], "x-public": true, "description": "Returns details for a single gallery." }, "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "format": "int32", "type": "integer" } }, { "description": "The ID of the gallery object.", "in": "path", "name": "gallery_id", "required": true, "schema": { "minimum": 0, "type": "integer" } } ], "patch": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GalleryUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Gallery" } } }, "description": "OK" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Update a gallery", "tags": [ "Gallery" ], "x-public": true, "description": "Updates a gallery's settings or metadata." } }, "/brands/{brand_id}/galleries/{gallery_id}/add_tags": { "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "format": "int32", "type": "integer" } }, { "description": "The ID of the gallery object.", "in": "path", "name": "gallery_id", "required": true, "schema": { "minimum": 0, "type": "integer" } } ], "post": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GalleryTagOperation" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Gallery" } } }, "description": "OK" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Add tags to the gallery.", "tags": [ "Gallery" ] } }, "/brands/{brand_id}/galleries/{gallery_id}/csv": { "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "format": "int32", "type": "integer" } }, { "description": "The ID of the gallery object.", "in": "path", "name": "gallery_id", "required": true, "schema": { "minimum": 0, "type": "integer" } } ], "post": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GalleryMediasCSVReport" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CSVTaskGenerated" } } }, "description": "Accepted" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Start the generation of the story frames CSV report for the given brand.", "tags": [ "Gallery" ] } }, "/brands/{brand_id}/galleries/{gallery_id}/gallery_media_products/csv": { "get": { "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CSVTaskGenerated" } } }, "description": "OK" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Produce a CSV of gallery media grouped by product URLs", "tags": [ "Gallery" ] }, "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "format": "int32", "type": "integer" } }, { "description": "The ID of the gallery object.", "in": "path", "name": "gallery_id", "required": true, "schema": { "minimum": 0, "type": "integer" } } ] }, "/brands/{brand_id}/galleries/{gallery_id}/media": { "delete": { "parameters": [ { "description": "A list of comma-separated IDs indicating the media items to delete.Selected media must belong to the specified gallery.", "in": "query", "name": "media_ids", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Delete a list of media objects by ID.", "tags": [ "Gallery" ] }, "get": { "parameters": [ { "description": "Sort by field. \"-\" for descending.", "in": "query", "name": "sort", "required": false, "schema": { "enum": [ "PUBLISHED_AT", "CREATED", "UPDATED", "ORDER", "VISITS", "ADDED", "POSTED", "CLICKS", "LIKESHOP_CLICKS", "PERFORMANCE", "VIDEO_VIEWS", "AVERAGE_VIDEO_WATCH_TIME", "INSTAGRAM_EFFECTIVENESS", "INSTAGRAM_REACH", "INSTAGRAM_ENGAGEMENT", "INSTAGRAM_ORGANIC_COMMENTS", "INSTAGRAM_PAID_COMMENTS", "INSTAGRAM_TOTAL_COMMENTS", "INSTAGRAM_ENGAGEMENT_RATE", "INSTAGRAM_ENGAGEMENT_RATE_VIEWS", "INSTAGRAM_ORGANIC_IMPRESSIONS", "INSTAGRAM_PAID_IMPRESSIONS", "INSTAGRAM_TOTAL_IMPRESSIONS", "INSTAGRAM_ORGANIC_LIKES", "INSTAGRAM_PAID_LIKES", "INSTAGRAM_TOTAL_LIKES", "INSTAGRAM_SAVES", "INSTAGRAM_TOTAL_ENGAGEMENTS", "INSTAGRAM_PAID_TOTAL_ENGAGEMENTS", "INSTAGRAM_SUM_TOTAL_ENGAGEMENTS", "INSTAGRAM_VIDEO_VIEWS", "INSTAGRAM_PAID_VIDEO_VIEWS", "INSTAGRAM_TOTAL_VIDEO_VIEWS", "INSTAGRAM_PAID_ENGAGEMENT_RATE", "INSTAGRAM_TOTAL_WATCH_TIME", "INSTAGRAM_STORY_REACH", "INSTAGRAM_STORY_IMPRESSIONS", "INSTAGRAM_STORY_SWIPE_UPS", "INSTAGRAM_STORY_REPLIES", "INSTAGRAM_STORY_EXIT_RATE", "PINTEREST_CLICKS", "PINTEREST_CLOSEUPS", "PINTEREST_COMMENTS", "PINTEREST_ENGAGEMENT", "PINTEREST_IMPRESSIONS", "PINTEREST_SAVES", "PINTEREST_VIDEO_VIEWS", "PINTEREST_AVERAGE_VIDEO_WATCH_TIME", "PINTEREST_ENGAGEMENTS", "DATE", "INSTAGRAM_STORY_FRAME_REACH", "INSTAGRAM_STORY_FRAME_IMPRESSIONS", "INSTAGRAM_STORY_FRAME_COMPLETION_RATE", "INSTAGRAM_STORY_FRAME_EXITS", "INSTAGRAM_STORY_FRAME_EXIT_RATE", "INSTAGRAM_STORY_FRAME_SWIPE_UPS", "INSTAGRAM_STORY_FRAME_REPLIES", "INSTAGRAM_STORY_FRAME_TAPS_BACK", "INSTAGRAM_STORY_FRAME_TAPS_FORWARD", "FACEBOOK_PHOTO_VIEW_CLICKS", "FACEBOOK_POST_CLICKS", "FACEBOOK_COMMENTS", "FACEBOOK_REACH", "FACEBOOK_EFFECTIVENESS", "FACEBOOK_REACTIONS", "FACEBOOK_ENGAGEMENT_RATE", "FACEBOOK_ENGAGEMENT_RATE_PUBLIC", "FACEBOOK_SHARES", "FACEBOOK_IMPRESSIONS", "FACEBOOK_TOTAL_ENGAGEMENTS", "FACEBOOK_TOTAL_ENGAGEMENTS_PUBLIC", "FACEBOOK_LINK_CLICKS", "FACEBOOK_VIDEO_COMPLETE_VIEWS", "FACEBOOK_OTHER_CLICKS", "FACEBOOK_VIDEO_VIEWS", "FACEBOOK_REELS_POST_VIDEO_VIEW_TIME", "FACEBOOK_REELS_POST_IMPRESSIONS_UNIQUE", "TWITTER_ENGAGEMENT_RATE", "TWITTER_IMPRESSIONS", "TWITTER_URL_CLICKS", "TWITTER_USER_PROFILE_CLICKS", "TWITTER_QUOTE_TWEETS", "TWITTER_REPLIES", "TWITTER_RETWEETS", "TWITTER_TOTAL_ENGAGEMENTS", "TWITTER_TOTAL_RETWEETS", "TWITTER_FOLLOWS", "TWITTER_VIDEO_VIEWS", "TIKTOK_REACH", "TIKTOK_AVERAGE_TIME_WATCHED", "TIKTOK_AVERAGE_COMPLETION_RATE", "TIKTOK_COMMENTS", "TIKTOK_IMPRESSIONS_SEARCH_RATE", "TIKTOK_FULL_VIDEO_WATCHED_RATE", "TIKTOK_SHARES", "TIKTOK_ENGAGEMENT_RATE", "TIKTOK_ENTERTAINMENT_SCORE", "TIKTOK_IMPRESSIONS_SOUND_RATE", "TIKTOK_IMPRESSIONS_FOLLOW_RATE", "TIKTOK_TOTAL_ENGAGEMENTS", "TIKTOK_IMPRESSIONS_FOR_YOU_RATE", "TIKTOK_TOTAL_TIME_WATCHED", "TIKTOK_IMPRESSIONS_HASHTAG_RATE", "TIKTOK_DURATION", "TIKTOK_LIKES", "TIKTOK_VIEWS", "TIKTOK_IMPRESSIONS_PERSONAL_PROFILE_RATE", "YOUTUBE_AVG_VIEW_PERCENTAGE", "YOUTUBE_AVG_VIEW_DURATION", "YOUTUBE_CARD_IMPRESSIONS", "YOUTUBE_CARD_CLICKS", "YOUTUBE_CARD_CLICK_RATE", "YOUTUBE_CARD_TEASER_CLICKS", "YOUTUBE_CARD_TEASER_CLICK_RATE", "YOUTUBE_CARD_TEASER_IMPRESSIONS", "YOUTUBE_COMMENTS", "YOUTUBE_DISLIKES", "YOUTUBE_LIKES", "YOUTUBE_PREMIUM_VIEWS", "YOUTUBE_EST_PREMIUM_SECONDS_WATCHED", "YOUTUBE_SHARES", "YOUTUBE_SUBSCRIBERS", "YOUTUBE_ENGAGEMENTS", "YOUTUBE_VIDEOS_ADDED_TO_PLAYLIST", "YOUTUBE_VIEWS", "YOUTUBE_EST_SECONDS_WATCHED", "LINKEDIN_CLICK_THROUGH_RATE", "LINKEDIN_CLICKS", "LINKEDIN_COMMENTS", "LINKEDIN_ENGAGEMENTS", "LINKEDIN_ENGAGEMENT_RATE", "LINKEDIN_IMPRESSIONS", "LINKEDIN_LIKES", "LINKEDIN_SHARES", "LINKEDIN_UNIQUE_IMPRESSIONS", "LINKEDIN_VIDEO_ANALYTICS_VIDEO_VIEWS", "LINKEDIN_VIDEO_ANALYTICS_TIME_WATCHED_FOR_VIEWS", "THREADS_ENGAGEMENTS", "THREADS_ENGAGEMENT_RATE", "THREADS_LIKES", "THREADS_QUOTES", "THREADS_REPLIES", "THREADS_REPOSTS", "THREADS_REPOSTS_AND_QUOTES", "THREADS_SHARES", "THREADS_VIEWS", "SNAPCHAT_AVG_VIEW_TIME_SECONDS", "SNAPCHAT_COMPLETES", "SNAPCHAT_ENGAGEMENT_RATE", "SNAPCHAT_ENGAGEMENTS", "SNAPCHAT_FAVORITES", "SNAPCHAT_INTERACTIONS", "SNAPCHAT_REPLIES", "SNAPCHAT_SHARES", "SNAPCHAT_SWIPE_DOWNS", "SNAPCHAT_SWIPE_UPS", "SNAPCHAT_UNIQUE_SESSIONS", "SNAPCHAT_VIEW_TIME_SECONDS", "SNAPCHAT_VIEWERS", "SNAPCHAT_VIEWS", "-PUBLISHED_AT", "-CREATED", "-UPDATED", "-ORDER", "-VISITS", "-ADDED", "-POSTED", "-CLICKS", "-LIKESHOP_CLICKS", "-PERFORMANCE", "-VIDEO_VIEWS", "-AVERAGE_VIDEO_WATCH_TIME", "-INSTAGRAM_EFFECTIVENESS", "-INSTAGRAM_REACH", "-INSTAGRAM_ENGAGEMENT", "-INSTAGRAM_ORGANIC_COMMENTS", "-INSTAGRAM_PAID_COMMENTS", "-INSTAGRAM_TOTAL_COMMENTS", "-INSTAGRAM_ENGAGEMENT_RATE", "-INSTAGRAM_ENGAGEMENT_RATE_VIEWS", "-INSTAGRAM_ORGANIC_IMPRESSIONS", "-INSTAGRAM_PAID_IMPRESSIONS", "-INSTAGRAM_TOTAL_IMPRESSIONS", "-INSTAGRAM_ORGANIC_LIKES", "-INSTAGRAM_PAID_LIKES", "-INSTAGRAM_TOTAL_LIKES", "-INSTAGRAM_SAVES", "-INSTAGRAM_TOTAL_ENGAGEMENTS", "-INSTAGRAM_PAID_TOTAL_ENGAGEMENTS", "-INSTAGRAM_SUM_TOTAL_ENGAGEMENTS", "-INSTAGRAM_VIDEO_VIEWS", "-INSTAGRAM_PAID_VIDEO_VIEWS", "-INSTAGRAM_TOTAL_VIDEO_VIEWS", "-INSTAGRAM_PAID_ENGAGEMENT_RATE", "-INSTAGRAM_TOTAL_WATCH_TIME", "-INSTAGRAM_STORY_REACH", "-INSTAGRAM_STORY_IMPRESSIONS", "-INSTAGRAM_STORY_SWIPE_UPS", "-INSTAGRAM_STORY_REPLIES", "-INSTAGRAM_STORY_EXIT_RATE", "-PINTEREST_CLICKS", "-PINTEREST_CLOSEUPS", "-PINTEREST_COMMENTS", "-PINTEREST_ENGAGEMENT", "-PINTEREST_IMPRESSIONS", "-PINTEREST_SAVES", "-PINTEREST_VIDEO_VIEWS", "-PINTEREST_AVERAGE_VIDEO_WATCH_TIME", "-PINTEREST_ENGAGEMENTS", "-DATE", "-INSTAGRAM_STORY_FRAME_REACH", "-INSTAGRAM_STORY_FRAME_IMPRESSIONS", "-INSTAGRAM_STORY_FRAME_COMPLETION_RATE", "-INSTAGRAM_STORY_FRAME_EXITS", "-INSTAGRAM_STORY_FRAME_EXIT_RATE", "-INSTAGRAM_STORY_FRAME_SWIPE_UPS", "-INSTAGRAM_STORY_FRAME_REPLIES", "-INSTAGRAM_STORY_FRAME_TAPS_BACK", "-INSTAGRAM_STORY_FRAME_TAPS_FORWARD", "-FACEBOOK_PHOTO_VIEW_CLICKS", "-FACEBOOK_POST_CLICKS", "-FACEBOOK_COMMENTS", "-FACEBOOK_REACH", "-FACEBOOK_EFFECTIVENESS", "-FACEBOOK_REACTIONS", "-FACEBOOK_ENGAGEMENT_RATE", "-FACEBOOK_ENGAGEMENT_RATE_PUBLIC", "-FACEBOOK_SHARES", "-FACEBOOK_IMPRESSIONS", "-FACEBOOK_TOTAL_ENGAGEMENTS", "-FACEBOOK_TOTAL_ENGAGEMENTS_PUBLIC", "-FACEBOOK_LINK_CLICKS", "-FACEBOOK_VIDEO_COMPLETE_VIEWS", "-FACEBOOK_OTHER_CLICKS", "-FACEBOOK_VIDEO_VIEWS", "-FACEBOOK_REELS_POST_VIDEO_VIEW_TIME", "-FACEBOOK_REELS_POST_IMPRESSIONS_UNIQUE", "-TWITTER_ENGAGEMENT_RATE", "-TWITTER_IMPRESSIONS", "-TWITTER_URL_CLICKS", "-TWITTER_USER_PROFILE_CLICKS", "-TWITTER_QUOTE_TWEETS", "-TWITTER_REPLIES", "-TWITTER_RETWEETS", "-TWITTER_TOTAL_ENGAGEMENTS", "-TWITTER_TOTAL_RETWEETS", "-TWITTER_FOLLOWS", "-TWITTER_VIDEO_VIEWS", "-TIKTOK_REACH", "-TIKTOK_AVERAGE_TIME_WATCHED", "-TIKTOK_AVERAGE_COMPLETION_RATE", "-TIKTOK_COMMENTS", "-TIKTOK_IMPRESSIONS_SEARCH_RATE", "-TIKTOK_FULL_VIDEO_WATCHED_RATE", "-TIKTOK_SHARES", "-TIKTOK_ENGAGEMENT_RATE", "-TIKTOK_ENTERTAINMENT_SCORE", "-TIKTOK_IMPRESSIONS_SOUND_RATE", "-TIKTOK_IMPRESSIONS_FOLLOW_RATE", "-TIKTOK_TOTAL_ENGAGEMENTS", "-TIKTOK_IMPRESSIONS_FOR_YOU_RATE", "-TIKTOK_TOTAL_TIME_WATCHED", "-TIKTOK_IMPRESSIONS_HASHTAG_RATE", "-TIKTOK_DURATION", "-TIKTOK_LIKES", "-TIKTOK_VIEWS", "-TIKTOK_IMPRESSIONS_PERSONAL_PROFILE_RATE", "-YOUTUBE_AVG_VIEW_PERCENTAGE", "-YOUTUBE_AVG_VIEW_DURATION", "-YOUTUBE_CARD_IMPRESSIONS", "-YOUTUBE_CARD_CLICKS", "-YOUTUBE_CARD_CLICK_RATE", "-YOUTUBE_CARD_TEASER_CLICKS", "-YOUTUBE_CARD_TEASER_CLICK_RATE", "-YOUTUBE_CARD_TEASER_IMPRESSIONS", "-YOUTUBE_COMMENTS", "-YOUTUBE_DISLIKES", "-YOUTUBE_LIKES", "-YOUTUBE_PREMIUM_VIEWS", "-YOUTUBE_EST_PREMIUM_SECONDS_WATCHED", "-YOUTUBE_SHARES", "-YOUTUBE_SUBSCRIBERS", "-YOUTUBE_ENGAGEMENTS", "-YOUTUBE_VIDEOS_ADDED_TO_PLAYLIST", "-YOUTUBE_VIEWS", "-YOUTUBE_EST_SECONDS_WATCHED", "-LINKEDIN_CLICK_THROUGH_RATE", "-LINKEDIN_CLICKS", "-LINKEDIN_COMMENTS", "-LINKEDIN_ENGAGEMENTS", "-LINKEDIN_ENGAGEMENT_RATE", "-LINKEDIN_IMPRESSIONS", "-LINKEDIN_LIKES", "-LINKEDIN_SHARES", "-LINKEDIN_UNIQUE_IMPRESSIONS", "-LINKEDIN_VIDEO_ANALYTICS_VIDEO_VIEWS", "-LINKEDIN_VIDEO_ANALYTICS_TIME_WATCHED_FOR_VIEWS", "-THREADS_ENGAGEMENTS", "-THREADS_ENGAGEMENT_RATE", "-THREADS_LIKES", "-THREADS_QUOTES", "-THREADS_REPLIES", "-THREADS_REPOSTS", "-THREADS_REPOSTS_AND_QUOTES", "-THREADS_SHARES", "-THREADS_VIEWS", "-SNAPCHAT_AVG_VIEW_TIME_SECONDS", "-SNAPCHAT_COMPLETES", "-SNAPCHAT_ENGAGEMENT_RATE", "-SNAPCHAT_ENGAGEMENTS", "-SNAPCHAT_FAVORITES", "-SNAPCHAT_INTERACTIONS", "-SNAPCHAT_REPLIES", "-SNAPCHAT_SHARES", "-SNAPCHAT_SWIPE_DOWNS", "-SNAPCHAT_SWIPE_UPS", "-SNAPCHAT_UNIQUE_SESSIONS", "-SNAPCHAT_VIEW_TIME_SECONDS", "-SNAPCHAT_VIEWERS", "-SNAPCHAT_VIEWS" ], "type": "string" } }, { "description": "Number of results to return in a single response.", "in": "query", "name": "limit", "required": false, "schema": { "default": 100, "maximum": 1000, "minimum": 1, "type": "integer" } }, { "description": "The offset of the first result to be returned.", "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "minimum": 0, "type": "integer" } }, { "description": "A formatted datetime string in UTC.", "in": "query", "name": "start_date", "required": false, "schema": { "default": null, "example": "2019-12-01", "nullable": true, "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(Z|((\\+|-)\\d{2}:\\d{2})))?$", "type": "string" } }, { "description": "A formatted datetime string in UTC.", "in": "query", "name": "end_date", "required": false, "schema": { "default": null, "example": "2019-12-12", "nullable": true, "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(Z|((\\+|-)\\d{2}:\\d{2})))?$", "type": "string" } }, { "description": "Only return media that have products.", "in": "query", "name": "with_products_only", "required": false, "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GalleryMediaList" } } }, "description": "OK" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "tags": [ "Gallery" ], "x-public": true, "summary": "Retrieve gallery media", "description": "Returns media items in a gallery." }, "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "format": "int32", "type": "integer" } }, { "description": "The ID of the gallery object.", "in": "path", "name": "gallery_id", "required": true, "schema": { "minimum": 0, "type": "integer" } } ], "post": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GalleryMediaMultiRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Gallery" } } }, "description": "OK" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Add media to gallery", "tags": [ "Gallery" ], "x-public": true, "description": "Adds a list of media objects to a gallery." } }, "/brands/{brand_id}/galleries/{gallery_id}/media/csv": { "get": { "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CSVTaskGenerated" } } }, "description": "OK" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Get a CSV file for gallery media stats.", "tags": [ "Gallery" ] }, "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "format": "int32", "type": "integer" } }, { "description": "The ID of the gallery object.", "in": "path", "name": "gallery_id", "required": true, "schema": { "minimum": 0, "type": "integer" } } ] }, "/brands/{brand_id}/galleries/{gallery_id}/media/v2": { "get": { "parameters": [ { "description": "Number of results to return in a single response.", "in": "query", "name": "limit", "required": false, "schema": { "default": 100, "maximum": 1000, "minimum": 0, "type": "integer" } }, { "description": "The offset of the first result to be returned.", "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "minimum": 0, "type": "integer" } }, { "description": "Comma-separated list of optional fields to include.", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "example": [ "source_data", "predictions" ], "items": { "enum": [ "predictions", "source_data" ], "type": "string" }, "type": "array" }, "style": "form" }, { "description": "Sort by field. \"-\" for descending.", "in": "query", "name": "sort", "required": false, "schema": { "enum": [ "ADDED", "POSTED", "CLICKS", "ORDER", "PERFORMANCE", "INSTAGRAM_EFFECTIVENESS", "INSTAGRAM_EFFECTIVENESS_ENGAGEMENTS", "INSTAGRAM_REACH", "INSTAGRAM_ENGAGEMENT", "INSTAGRAM_ORGANIC_COMMENTS", "INSTAGRAM_PAID_COMMENTS", "INSTAGRAM_TOTAL_COMMENTS", "INSTAGRAM_ENGAGEMENT_RATE", "INSTAGRAM_ENGAGEMENT_RATE_VIEWS", "INSTAGRAM_ENTERTAINMENT_SCORE", "INSTAGRAM_ORGANIC_IMPRESSIONS", "INSTAGRAM_PAID_IMPRESSIONS", "INSTAGRAM_TOTAL_IMPRESSIONS", "INSTAGRAM_ORGANIC_LIKES", "INSTAGRAM_PAID_LIKES", "INSTAGRAM_TOTAL_LIKES", "INSTAGRAM_SAVES", "INSTAGRAM_SHARES", "INSTAGRAM_TOTAL_ENGAGEMENTS", "INSTAGRAM_PAID_TOTAL_ENGAGEMENTS", "INSTAGRAM_SUM_TOTAL_ENGAGEMENTS", "INSTAGRAM_VIDEO_VIEWS", "INSTAGRAM_PAID_VIDEO_VIEWS", "INSTAGRAM_TOTAL_VIDEO_VIEWS", "INSTAGRAM_VIEWS", "INSTAGRAM_PAID_ENGAGEMENT_RATE", "INSTAGRAM_TOTAL_WATCH_TIME", "LIKESHOP_CLICKS", "INSTAGRAM_STORY_REACH", "INSTAGRAM_STORY_IMPRESSIONS", "INSTAGRAM_STORY_SWIPE_UPS", "INSTAGRAM_STORY_REPLIES", "INSTAGRAM_STORY_EXIT_RATE", "DATE", "INSTAGRAM_STORY_FRAME_ADDED", "INSTAGRAM_STORY_FRAME_REACH", "INSTAGRAM_STORY_FRAME_IMPRESSIONS", "INSTAGRAM_STORY_FRAME_COMPLETION_RATE", "INSTAGRAM_STORY_FRAME_EXITS", "INSTAGRAM_STORY_FRAME_EXIT_RATE", "INSTAGRAM_STORY_FRAME_SWIPE_UPS", "INSTAGRAM_STORY_FRAME_REPLIES", "INSTAGRAM_STORY_FRAME_TAPS_BACK", "INSTAGRAM_STORY_FRAME_TAPS_FORWARD", "INSTAGRAM_STORY_FRAME_VIEWS_V2", "INSTAGRAM_STORY_FRAME_EXIT_RATE_VIEWS", "INSTAGRAM_STORY_FRAME_COMPLETION_RATE_VIEWS", "TIKTOK_REACH", "TIKTOK_AVERAGE_TIME_WATCHED", "TIKTOK_AVERAGE_COMPLETION_RATE", "TIKTOK_COMMENTS", "TIKTOK_IMPRESSIONS_SEARCH_RATE", "TIKTOK_FULL_VIDEO_WATCHED_RATE", "TIKTOK_SHARES", "TIKTOK_IMPRESSIONS_SOUND_RATE", "TIKTOK_ENGAGEMENT_RATE", "TIKTOK_ENTERTAINMENT_SCORE", "TIKTOK_TOTAL_ENGAGEMENTS", "TIKTOK_IMPRESSIONS_FOLLOW_RATE", "TIKTOK_TOTAL_TIME_WATCHED", "TIKTOK_DURATION", "TIKTOK_IMPRESSIONS_HASHTAG_RATE", "TIKTOK_VIEWS", "TIKTOK_LIKES", "TIKTOK_IMPRESSIONS_PERSONAL_PROFILE_RATE", "TIKTOK_IMPRESSIONS_FOR_YOU_RATE", "FACEBOOK_PHOTO_VIEW_CLICKS", "FACEBOOK_POST_CLICKS", "FACEBOOK_COMMENTS", "FACEBOOK_REACH", "FACEBOOK_EFFECTIVENESS", "FACEBOOK_REACTIONS", "FACEBOOK_ENGAGEMENT_RATE", "FACEBOOK_SHARES", "FACEBOOK_IMPRESSIONS", "FACEBOOK_TOTAL_ENGAGEMENTS", "FACEBOOK_TOTAL_ENGAGEMENTS_PUBLIC", "FACEBOOK_ENGAGEMENT_RATE_PUBLIC", "FACEBOOK_LINK_CLICKS", "FACEBOOK_VIDEO_COMPLETE_VIEWS", "FACEBOOK_OTHER_CLICKS", "FACEBOOK_VIDEO_VIEWS", "FACEBOOK_ORGANIC_VIDEO_COMPLETE_VIEWS", "FACEBOOK_ORGANIC_VIDEO_VIEWS", "FACEBOOK_PAID_AND_ORGANIC_COMMENTS", "FACEBOOK_PAID_AND_ORGANIC_EFFECTIVENESS_V2", "FACEBOOK_PAID_AND_ORGANIC_ENGAGEMENT_RATE_V2", "FACEBOOK_PAID_AND_ORGANIC_ENGAGEMENTS_V2", "FACEBOOK_PAID_AND_ORGANIC_LINK_CLICKS", "FACEBOOK_PAID_AND_ORGANIC_OTHER_CLICKS", "FACEBOOK_PAID_AND_ORGANIC_PHOTO_VIEW_CLICKS", "FACEBOOK_PAID_AND_ORGANIC_POST_CLICKS", "FACEBOOK_PAID_AND_ORGANIC_REACH_V2", "FACEBOOK_PAID_AND_ORGANIC_REACTIONS", "FACEBOOK_PAID_AND_ORGANIC_SHARES", "FACEBOOK_PAID_AND_ORGANIC_VIEWS", "FACEBOOK_REELS_POST_VIDEO_VIEW_TIME", "FACEBOOK_REELS_POST_IMPRESSIONS_UNIQUE", "PINTEREST_CLICKS", "PINTEREST_CLOSEUPS", "PINTEREST_COMMENTS", "PINTEREST_ENGAGEMENT", "PINTEREST_IMPRESSIONS", "PINTEREST_SAVES", "PINTEREST_VIDEO_VIEWS", "PINTEREST_AVERAGE_VIDEO_WATCH_TIME", "PINTEREST_ENGAGEMENTS", "TWITTER_ENGAGEMENT_RATE", "TWITTER_IMPRESSIONS", "TWITTER_URL_CLICKS", "TWITTER_USER_PROFILE_CLICKS", "TWITTER_QUOTE_TWEETS", "TWITTER_REPLIES", "TWITTER_RETWEETS", "TWITTER_TOTAL_ENGAGEMENTS", "TWITTER_TOTAL_RETWEETS", "TWITTER_FOLLOWS", "TWITTER_VIDEO_VIEWS", "TWITTER_LIKES", "YOUTUBE_AVG_VIEW_PERCENTAGE", "YOUTUBE_AVG_VIEW_DURATION", "YOUTUBE_CARD_IMPRESSIONS", "YOUTUBE_CARD_CLICKS", "YOUTUBE_CARD_CLICK_RATE", "YOUTUBE_CARD_TEASER_CLICKS", "YOUTUBE_CARD_TEASER_CLICK_RATE", "YOUTUBE_CARD_TEASER_IMPRESSIONS", "YOUTUBE_COMMENTS", "YOUTUBE_DISLIKES", "YOUTUBE_LIKES", "YOUTUBE_PREMIUM_VIEWS", "YOUTUBE_EST_PREMIUM_SECONDS_WATCHED", "YOUTUBE_SHARES", "YOUTUBE_SUBSCRIBERS", "YOUTUBE_ENGAGEMENTS", "YOUTUBE_VIDEOS_ADDED_TO_PLAYLIST", "YOUTUBE_VIEWS", "YOUTUBE_EST_SECONDS_WATCHED", "LINKEDIN_CLICK_THROUGH_RATE", "LINKEDIN_CLICKS", "LINKEDIN_COMMENTS", "LINKEDIN_ENGAGEMENTS", "LINKEDIN_ENGAGEMENT_RATE", "LINKEDIN_IMPRESSIONS", "LINKEDIN_LIKES", "LINKEDIN_SHARES", "LINKEDIN_UNIQUE_IMPRESSIONS", "LINKEDIN_VIDEO_ANALYTICS_VIDEO_VIEWS", "LINKEDIN_VIDEO_ANALYTICS_TIME_WATCHED_FOR_VIEWS", "THREADS_ENGAGEMENTS", "THREADS_ENGAGEMENT_RATE", "THREADS_LIKES", "THREADS_QUOTES", "THREADS_REPLIES", "THREADS_REPOSTS", "THREADS_REPOSTS_AND_QUOTES", "THREADS_SHARES", "THREADS_VIEWS", "SNAPCHAT_AVG_VIEW_TIME_SECONDS", "SNAPCHAT_COMPLETES", "SNAPCHAT_ENGAGEMENT_RATE", "SNAPCHAT_ENGAGEMENTS", "SNAPCHAT_FAVORITES", "SNAPCHAT_INTERACTIONS", "SNAPCHAT_REPLIES", "SNAPCHAT_SHARES", "SNAPCHAT_SWIPE_DOWNS", "SNAPCHAT_SWIPE_UPS", "SNAPCHAT_UNIQUE_SESSIONS", "SNAPCHAT_VIEW_TIME_SECONDS", "SNAPCHAT_VIEWERS", "SNAPCHAT_VIEWS", "-ADDED", "-POSTED", "-CLICKS", "-ORDER", "-PERFORMANCE", "-INSTAGRAM_EFFECTIVENESS", "-INSTAGRAM_EFFECTIVENESS_ENGAGEMENTS", "-INSTAGRAM_REACH", "-INSTAGRAM_ENGAGEMENT", "-INSTAGRAM_ORGANIC_COMMENTS", "-INSTAGRAM_PAID_COMMENTS", "-INSTAGRAM_TOTAL_COMMENTS", "-INSTAGRAM_ENGAGEMENT_RATE", "-INSTAGRAM_ENGAGEMENT_RATE_VIEWS", "-INSTAGRAM_ENTERTAINMENT_SCORE", "-INSTAGRAM_ORGANIC_IMPRESSIONS", "-INSTAGRAM_PAID_IMPRESSIONS", "-INSTAGRAM_TOTAL_IMPRESSIONS", "-INSTAGRAM_ORGANIC_LIKES", "-INSTAGRAM_PAID_LIKES", "-INSTAGRAM_TOTAL_LIKES", "-INSTAGRAM_SAVES", "-INSTAGRAM_SHARES", "-INSTAGRAM_TOTAL_ENGAGEMENTS", "-INSTAGRAM_PAID_TOTAL_ENGAGEMENTS", "-INSTAGRAM_SUM_TOTAL_ENGAGEMENTS", "-INSTAGRAM_VIDEO_VIEWS", "-INSTAGRAM_PAID_VIDEO_VIEWS", "-INSTAGRAM_TOTAL_VIDEO_VIEWS", "-INSTAGRAM_VIEWS", "-INSTAGRAM_PAID_ENGAGEMENT_RATE", "-INSTAGRAM_TOTAL_WATCH_TIME", "-LIKESHOP_CLICKS", "-INSTAGRAM_STORY_REACH", "-INSTAGRAM_STORY_IMPRESSIONS", "-INSTAGRAM_STORY_SWIPE_UPS", "-INSTAGRAM_STORY_REPLIES", "-INSTAGRAM_STORY_EXIT_RATE", "-DATE", "-INSTAGRAM_STORY_FRAME_ADDED", "-INSTAGRAM_STORY_FRAME_REACH", "-INSTAGRAM_STORY_FRAME_IMPRESSIONS", "-INSTAGRAM_STORY_FRAME_COMPLETION_RATE", "-INSTAGRAM_STORY_FRAME_EXITS", "-INSTAGRAM_STORY_FRAME_EXIT_RATE", "-INSTAGRAM_STORY_FRAME_SWIPE_UPS", "-INSTAGRAM_STORY_FRAME_REPLIES", "-INSTAGRAM_STORY_FRAME_TAPS_BACK", "-INSTAGRAM_STORY_FRAME_TAPS_FORWARD", "-INSTAGRAM_STORY_FRAME_VIEWS_V2", "-INSTAGRAM_STORY_FRAME_EXIT_RATE_VIEWS", "-INSTAGRAM_STORY_FRAME_COMPLETION_RATE_VIEWS", "-TIKTOK_REACH", "-TIKTOK_AVERAGE_TIME_WATCHED", "-TIKTOK_AVERAGE_COMPLETION_RATE", "-TIKTOK_COMMENTS", "-TIKTOK_IMPRESSIONS_SEARCH_RATE", "-TIKTOK_FULL_VIDEO_WATCHED_RATE", "-TIKTOK_SHARES", "-TIKTOK_IMPRESSIONS_SOUND_RATE", "-TIKTOK_ENGAGEMENT_RATE", "-TIKTOK_ENTERTAINMENT_SCORE", "-TIKTOK_TOTAL_ENGAGEMENTS", "-TIKTOK_IMPRESSIONS_FOLLOW_RATE", "-TIKTOK_TOTAL_TIME_WATCHED", "-TIKTOK_DURATION", "-TIKTOK_IMPRESSIONS_HASHTAG_RATE", "-TIKTOK_VIEWS", "-TIKTOK_LIKES", "-TIKTOK_IMPRESSIONS_PERSONAL_PROFILE_RATE", "-TIKTOK_IMPRESSIONS_FOR_YOU_RATE", "-FACEBOOK_PHOTO_VIEW_CLICKS", "-FACEBOOK_POST_CLICKS", "-FACEBOOK_COMMENTS", "-FACEBOOK_REACH", "-FACEBOOK_EFFECTIVENESS", "-FACEBOOK_REACTIONS", "-FACEBOOK_ENGAGEMENT_RATE", "-FACEBOOK_SHARES", "-FACEBOOK_IMPRESSIONS", "-FACEBOOK_TOTAL_ENGAGEMENTS", "-FACEBOOK_TOTAL_ENGAGEMENTS_PUBLIC", "-FACEBOOK_ENGAGEMENT_RATE_PUBLIC", "-FACEBOOK_LINK_CLICKS", "-FACEBOOK_VIDEO_COMPLETE_VIEWS", "-FACEBOOK_OTHER_CLICKS", "-FACEBOOK_VIDEO_VIEWS", "-FACEBOOK_ORGANIC_VIDEO_COMPLETE_VIEWS", "-FACEBOOK_ORGANIC_VIDEO_VIEWS", "-FACEBOOK_PAID_AND_ORGANIC_COMMENTS", "-FACEBOOK_PAID_AND_ORGANIC_EFFECTIVENESS_V2", "-FACEBOOK_PAID_AND_ORGANIC_ENGAGEMENT_RATE_V2", "-FACEBOOK_PAID_AND_ORGANIC_ENGAGEMENTS_V2", "-FACEBOOK_PAID_AND_ORGANIC_LINK_CLICKS", "-FACEBOOK_PAID_AND_ORGANIC_OTHER_CLICKS", "-FACEBOOK_PAID_AND_ORGANIC_PHOTO_VIEW_CLICKS", "-FACEBOOK_PAID_AND_ORGANIC_POST_CLICKS", "-FACEBOOK_PAID_AND_ORGANIC_REACH_V2", "-FACEBOOK_PAID_AND_ORGANIC_REACTIONS", "-FACEBOOK_PAID_AND_ORGANIC_SHARES", "-FACEBOOK_PAID_AND_ORGANIC_VIEWS", "-FACEBOOK_REELS_POST_VIDEO_VIEW_TIME", "-FACEBOOK_REELS_POST_IMPRESSIONS_UNIQUE", "-PINTEREST_CLICKS", "-PINTEREST_CLOSEUPS", "-PINTEREST_COMMENTS", "-PINTEREST_ENGAGEMENT", "-PINTEREST_IMPRESSIONS", "-PINTEREST_SAVES", "-PINTEREST_VIDEO_VIEWS", "-PINTEREST_AVERAGE_VIDEO_WATCH_TIME", "-PINTEREST_ENGAGEMENTS", "-TWITTER_ENGAGEMENT_RATE", "-TWITTER_IMPRESSIONS", "-TWITTER_URL_CLICKS", "-TWITTER_USER_PROFILE_CLICKS", "-TWITTER_QUOTE_TWEETS", "-TWITTER_REPLIES", "-TWITTER_RETWEETS", "-TWITTER_TOTAL_ENGAGEMENTS", "-TWITTER_TOTAL_RETWEETS", "-TWITTER_FOLLOWS", "-TWITTER_VIDEO_VIEWS", "-TWITTER_LIKES", "-YOUTUBE_AVG_VIEW_PERCENTAGE", "-YOUTUBE_AVG_VIEW_DURATION", "-YOUTUBE_CARD_IMPRESSIONS", "-YOUTUBE_CARD_CLICKS", "-YOUTUBE_CARD_CLICK_RATE", "-YOUTUBE_CARD_TEASER_CLICKS", "-YOUTUBE_CARD_TEASER_CLICK_RATE", "-YOUTUBE_CARD_TEASER_IMPRESSIONS", "-YOUTUBE_COMMENTS", "-YOUTUBE_DISLIKES", "-YOUTUBE_LIKES", "-YOUTUBE_PREMIUM_VIEWS", "-YOUTUBE_EST_PREMIUM_SECONDS_WATCHED", "-YOUTUBE_SHARES", "-YOUTUBE_SUBSCRIBERS", "-YOUTUBE_ENGAGEMENTS", "-YOUTUBE_VIDEOS_ADDED_TO_PLAYLIST", "-YOUTUBE_VIEWS", "-YOUTUBE_EST_SECONDS_WATCHED", "-LINKEDIN_CLICK_THROUGH_RATE", "-LINKEDIN_CLICKS", "-LINKEDIN_COMMENTS", "-LINKEDIN_ENGAGEMENTS", "-LINKEDIN_ENGAGEMENT_RATE", "-LINKEDIN_IMPRESSIONS", "-LINKEDIN_LIKES", "-LINKEDIN_SHARES", "-LINKEDIN_UNIQUE_IMPRESSIONS", "-LINKEDIN_VIDEO_ANALYTICS_VIDEO_VIEWS", "-LINKEDIN_VIDEO_ANALYTICS_TIME_WATCHED_FOR_VIEWS", "-THREADS_ENGAGEMENTS", "-THREADS_ENGAGEMENT_RATE", "-THREADS_LIKES", "-THREADS_QUOTES", "-THREADS_REPLIES", "-THREADS_REPOSTS", "-THREADS_REPOSTS_AND_QUOTES", "-THREADS_SHARES", "-THREADS_VIEWS", "-SNAPCHAT_AVG_VIEW_TIME_SECONDS", "-SNAPCHAT_COMPLETES", "-SNAPCHAT_ENGAGEMENT_RATE", "-SNAPCHAT_ENGAGEMENTS", "-SNAPCHAT_FAVORITES", "-SNAPCHAT_INTERACTIONS", "-SNAPCHAT_REPLIES", "-SNAPCHAT_SHARES", "-SNAPCHAT_SWIPE_DOWNS", "-SNAPCHAT_SWIPE_UPS", "-SNAPCHAT_UNIQUE_SESSIONS", "-SNAPCHAT_VIEW_TIME_SECONDS", "-SNAPCHAT_VIEWERS", "-SNAPCHAT_VIEWS" ], "type": "string" } }, { "description": "A formatted datetime string in UTC.", "in": "query", "name": "start_date", "required": false, "schema": { "default": null, "example": "2019-12-01", "nullable": true, "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(Z|((\\+|-)\\d{2}:\\d{2})))?$", "type": "string" } }, { "description": "A formatted datetime string in UTC.", "in": "query", "name": "end_date", "required": false, "schema": { "default": null, "example": "2019-12-12", "nullable": true, "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(Z|((\\+|-)\\d{2}:\\d{2})))?$", "type": "string" } }, { "description": "Only return media that have products", "in": "query", "name": "with_products_only", "required": false, "schema": { "default": false, "type": "boolean" } }, { "description": "Only return media for likeshop feed", "in": "query", "name": "exclude_instagram_owned_without_products", "required": false, "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GalleryMediaListSchemaV2" } } }, "description": "OK" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Get a list of gallery media v2 objects.", "tags": [ "Gallery" ] }, "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "format": "int32", "type": "integer" } }, { "description": "The ID of the gallery object.", "in": "path", "name": "gallery_id", "required": true, "schema": { "minLength": 1, "type": "string" } } ] }, "/brands/{brand_id}/galleries/{gallery_id}/media/{media_id}": { "delete": { "responses": { "204": { "description": "No Content" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Delete a media object by its ID.", "tags": [ "Gallery" ] }, "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "format": "int32", "type": "integer" } }, { "description": "The ID of the gallery object.", "in": "path", "name": "gallery_id", "required": true, "schema": { "minimum": 0, "type": "integer" } }, { "description": "The ID of the media object.", "in": "path", "name": "media_id", "required": true, "schema": { "format": "int32", "type": "integer" } } ] }, "/brands/{brand_id}/galleries/{gallery_id}/order": { "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "format": "int32", "type": "integer" } }, { "description": "The ID of the gallery object.", "in": "path", "name": "gallery_id", "required": true, "schema": { "minimum": 0, "type": "integer" } } ], "patch": { "requestBody": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/GalleryOrderRequest" }, "type": "array" } } }, "required": true }, "responses": { "204": { "description": "No Content" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Change media order for regular galleries and likeshop.", "tags": [ "Gallery" ] } }, "/brands/{brand_id}/galleries/{gallery_id}/remove_tags": { "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "format": "int32", "type": "integer" } }, { "description": "The ID of the gallery object.", "in": "path", "name": "gallery_id", "required": true, "schema": { "minimum": 0, "type": "integer" } } ], "post": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GalleryTagOperation" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Gallery" } } }, "description": "OK" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Remove tags from gallery.", "tags": [ "Gallery" ] } }, "/brands/{brand_id}/galleries/{gallery_id}/stats": { "get": { "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Gallery" } } }, "description": "OK" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Retrieve gallery statistics", "tags": [ "Gallery" ], "x-public": true, "description": "Returns performance statistics for a gallery." }, "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "minimum": 0, "type": "integer" } }, { "description": "The ID of the gallery.", "in": "path", "name": "gallery_id", "required": true, "schema": { "minimum": 0, "type": "integer" } } ] }, "/brands/{brand_id}/galleries/{gallery_id}/stats/csv": { "get": { "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GalleryStatsCSVReport" } } }, "description": "OK" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Download csv of stats for a gallery", "tags": [ "Gallery" ] }, "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "minimum": 0, "type": "integer" } }, { "description": "The ID of the gallery.", "in": "path", "name": "gallery_id", "required": true, "schema": { "minimum": 0, "type": "integer" } } ] }, "/brands/{brand_id}/galleries/{gallery_id}/sync_media_created_at": { "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "format": "int32", "type": "integer" } }, { "description": "The ID of the gallery object.", "in": "path", "name": "gallery_id", "required": true, "schema": { "minimum": 0, "type": "integer" } } ], "post": { "responses": { "204": { "description": "No Content" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Sync gallery media created at with media source_created_at", "tags": [ "Gallery" ] } }, "/brands/{brand_id}/galleries/{gallery_id}/ugc_as_alt_image/csv": { "get": { "parameters": [ { "description": "The socket id of the requesting entity.", "in": "query", "name": "socket_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CSVTaskGenerated" } } }, "description": "OK" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Start the generation of the Gallery UGC as alt image CSV for the given gallery.", "tags": [ "Gallery" ] }, "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "format": "int32", "type": "integer" } }, { "description": "The ID of the gallery object.", "in": "path", "name": "gallery_id", "required": true, "schema": { "minimum": 0, "type": "integer" } } ] }, "/brands/{brand_id}/gallery_tags": { "get": { "parameters": [ { "description": "Flag to only return tags currently in use.", "in": "query", "name": "active_only", "required": false, "schema": { "default": false, "type": "boolean" } }, { "description": "Type of the gallery.", "in": "query", "name": "gallery_type", "required": false, "schema": { "enum": [ "instagram", "INSTAGRAM", "instagram_likeshop", "INSTAGRAM_LIKESHOP", "pinterest", "PINTEREST", "library", "LIBRARY", "instagram_story", "INSTAGRAM_STORY", "instagram_story_narrative", "INSTAGRAM_STORY_NARRATIVE", "tiktok", "TIKTOK", "tiktok_likeshop", "TIKTOK_LIKESHOP", "facebook", "FACEBOOK", "twitter", "TWITTER", "youtube", "YOUTUBE", "linkedin", "LINKEDIN", "threads", "THREADS", "snapchat", "SNAPCHAT", null ], "nullable": true, "type": "string" } }, { "description": "sort field", "in": "query", "name": "sort", "required": false, "schema": { "enum": [ "NAME", "-NAME" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/GalleryTag" }, "type": "array" } } }, "description": "OK" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "List Gallery Tags.", "tags": [ "GalleryTags" ] }, "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "format": "int32", "type": "integer" } } ], "post": { "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GalleryTag" } } }, "description": "Created" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Add a new tag to the gallery", "tags": [ "GalleryTags" ] } }, "/brands/{brand_id}/gallery_tags/{gallery_tag_id}": { "delete": { "responses": { "200": { "description": "OK" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Delete gallery tag by ID.", "tags": [ "GalleryTags" ] }, "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "format": "int32", "type": "integer" } }, { "description": "The ID of the gallery tag.", "in": "path", "name": "gallery_tag_id", "required": true, "schema": { "format": "int32", "type": "integer" } } ], "patch": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GalleryUpdateTag" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GalleryTag" } } }, "description": "OK" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Update the gallery tag by ID.", "tags": [ "GalleryTags" ] } }, "/brands/{brand_id}/gallery_transfers": { "get": { "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/GalleryTransferResponse" }, "type": "array" } } }, "description": "OK" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Get Gallery Transfers for a brand", "tags": [ "GalleryTransfer" ] }, "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "format": "int32", "type": "integer" } } ], "post": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StartGalleryTransferRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GalleryTransferResponse" } } }, "description": "Created" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Start a Gallery Transfer", "tags": [ "GalleryTransfer" ] } }, "/brands/{brand_id}/gallery_transfers/{gallery_transfer_id}": { "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "format": "int32", "type": "integer" } }, { "description": "The Dash Social assigned ID of the Gallery Transfer.", "in": "path", "name": "gallery_transfer_id", "required": true, "schema": { "format": "int32", "type": "integer" } } ], "post": { "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GalleryTransferResponse" } } }, "description": "OK" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Restart a gallery transfer from the current stage", "tags": [ "GalleryTransfer" ] } }, "/brands/{brand_id}/google_analytics/account": { "delete": { "responses": { "204": { "description": "No Content" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "tags": [ "GoogleAnalytics" ] }, "get": { "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GoogleAnalyticsAccountResponse" } } }, "description": "OK" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "tags": [ "GoogleAnalytics" ] }, "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "format": "int32", "type": "integer" } } ], "post": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GoogleAnalyticsCreateAccount" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GoogleAnalyticsAccountResponse" } } }, "description": "OK" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Create a new Google Analytics Account", "tags": [ "GoogleAnalytics" ] } }, "/brands/{brand_id}/google_analytics/account/report": { "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "format": "int32", "type": "integer" } } ], "post": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GoogleAnalyticsReportRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GoogleAnalyticsReportResponse" } } }, "description": "OK" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Get a Google Analytics report", "tags": [ "GoogleAnalytics" ] } }, "/brands/{brand_id}/google_analytics/accounts": { "get": { "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/GoogleAnalyticsAccount" }, "type": "array" } } }, "description": "OK" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "List Google Analytics accounts the brand has access to", "tags": [ "GoogleAnalytics" ] }, "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "format": "int32", "type": "integer" } } ] }, "/brands/{brand_id}/google_analytics/list_accounts": { "get": { "parameters": [ { "description": "Comma-separated list of IDs to return.", "explode": false, "in": "query", "name": "brand_ids", "required": true, "schema": { "items": { "type": "integer" }, "type": "array" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/GoogleAnalyticsValidate" }, "type": "array" } } }, "description": "OK" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "tags": [ "GoogleAnalytics" ] }, "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "format": "int32", "type": "integer" } } ] }, "/brands/{brand_id}/media/v2": { "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "format": "int32", "type": "integer" } } ], "post": { "description": "Creates a new media object for a brand.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaV2" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaV2" } } }, "description": "Created" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Create a media object", "tags": [ "Media" ], "x-public": true }, "put": { "parameters": [ { "description": "Number of results to return in a single response.", "in": "query", "name": "limit", "required": false, "schema": { "default": 100, "maximum": 1000, "minimum": 0, "type": "integer" } }, { "description": "The offset of the first result to be returned.", "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "minimum": 0, "type": "integer" } }, { "description": "Comma-separated list of IDs to return.", "explode": false, "in": "query", "name": "ids", "required": false, "schema": { "example": [ 812371, 828318 ], "items": { "type": "integer" }, "type": "array" }, "style": "form" }, { "description": "Comma-separated list of optional fields to include.", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "example": [ "predictions" ], "items": { "enum": [ "predictions", "source_data", "comment_sentiment", "visual_features" ], "type": "string" }, "type": "array" }, "style": "form" }, { "description": "Comma-separated list of optional fields to exclude.", "explode": false, "in": "query", "name": "exclude", "required": false, "schema": { "example": [ "source_data" ], "items": { "enum": [ "predictions", "source_data", "comment_sentiment", "visual_features" ], "type": "string" }, "type": "array" }, "style": "form" }, { "description": "Next token for deep pagination", "in": "query", "name": "next_token", "required": false, "schema": { "example": "123123123,321321321", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchMedia" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaV2List" } } }, "description": "OK" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Retrieve media", "tags": [ "Media" ], "x-public": true, "description": "Returns a paginated list of media objects for a brand. Filter by platform, date range, media type, and more using the request body." } }, "/brands/{brand_id}/media/v2/csv": { "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "format": "int32", "type": "integer" } } ], "put": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaV2CSVRequest" } } }, "required": true }, "responses": { "202": { "description": "Accepted" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Generate CSV for a list of media objects", "tags": [ "Media" ] } }, "/brands/{brand_id}/media/v2/{media_id}": { "get": { "parameters": [ { "description": "Comma-separated list of optional fields to exclude.", "explode": false, "in": "query", "name": "exclude", "required": false, "schema": { "example": [ "source_data" ], "items": { "enum": [ "predictions", "source_data", "comment_sentiment", "visual_features" ], "type": "string" }, "type": "array" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaV2" } } }, "description": "OK" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "tags": [ "Media" ], "x-public": true, "summary": "Retrieve a media object", "description": "Returns details for a single media object by ID." }, "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "format": "int32", "type": "integer" } }, { "description": "The ID of the media object.", "in": "path", "name": "media_id", "required": true, "schema": { "format": "int32", "type": "integer" } } ] }, "/brands/{brand_id}/media/{media_id}": { "delete": { "responses": { "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "tags": [ "Single Media" ] }, "get": { "responses": { "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "tags": [ "Single Media" ] }, "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "minimum": 0, "type": "integer" } }, { "description": "The Dash Social assigned ID of the media.", "in": "path", "name": "media_id", "required": true, "schema": { "minimum": 0, "type": "integer" } } ], "patch": { "responses": { "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "tags": [ "Single Media" ] } }, "/brands/{brand_id}/media/{media_id}/custom_metrics": { "get": { "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomMetricResponse" } } }, "description": "OK" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "tags": [ "Single Media" ] }, "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "minimum": 0, "type": "integer" } }, { "description": "The Dash Social assigned ID of the media.", "in": "path", "name": "media_id", "required": true, "schema": { "minimum": 0, "type": "integer" } } ] }, "/brands/{brand_id}/media/{media_id}/tags": { "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "minimum": 0, "type": "integer" } }, { "description": "The Dash Social assigned ID of the media.", "in": "path", "name": "media_id", "required": true, "schema": { "minimum": 0, "type": "integer" } } ], "post": { "responses": { "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "tags": [ "Single Media" ] } }, "/brands/{brand_id}/media/{media_id}/tags/{tag_id}": { "delete": { "responses": { "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "tags": [ "Single Media" ] }, "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "minimum": 0, "type": "integer" } }, { "description": "The Dash Social assigned ID of the media.", "in": "path", "name": "media_id", "required": true, "schema": { "minimum": 0, "type": "integer" } }, { "in": "path", "name": "tag_id", "required": true, "schema": { "minimum": 0, "type": "integer" } } ] }, "/brands/{brand_id}/media_predictions": { "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "format": "int32", "type": "integer" } } ], "post": { "requestBody": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/MediaPredictionFile" }, "type": "array" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "tags": [ "MediaV1" ] } }, "/brands/{brand_id}/media_search": { "get": { "parameters": [ { "in": "query", "name": "query", "required": false, "schema": { "default": null, "nullable": true, "type": "string" } }, { "in": "query", "name": "media_id", "required": false, "schema": { "default": null, "nullable": true, "type": "integer" } }, { "in": "query", "name": "image_data", "required": false, "schema": { "default": false, "nullable": true, "type": "boolean" } }, { "description": "list of brand media types", "explode": false, "in": "query", "name": "sources", "required": false, "schema": { "example": [ "INSTAGRAM_OWNED", "INSTAGRAM_OWNED_IGTV" ], "items": { "enum": [ "instagram_owned", "INSTAGRAM_OWNED", "instagram_ugc", "INSTAGRAM_UGC", "instagram_other", "INSTAGRAM_OTHER", "instagram_owned_igtv", "INSTAGRAM_OWNED_IGTV", "instagram_ugc_igtv", "INSTAGRAM_UGC_IGTV", "instagram_other_igtv", "INSTAGRAM_OTHER_IGTV", "instagram_story", "INSTAGRAM_STORY", "instagram_story_ugc", "INSTAGRAM_STORY_UGC", "instagram_ads", "INSTAGRAM_ADS", "uploaded", "UPLOADED", "edited", "EDITED", "ai_generated", "AI_GENERATED", "pinterest_owned", "PINTEREST_OWNED", "pinterest_story", "PINTEREST_STORY", "pinterest_ugc", "PINTEREST_UGC", "facebook_owned", "FACEBOOK_OWNED", "facebook_ads", "FACEBOOK_ADS", "facebook_post_ad", "FACEBOOK_POST_AD", "facebook_post_ad_l", "FACEBOOK_POST_AD_L", "facebook_post_ad_t", "FACEBOOK_POST_AD_T", "facebook_post_ad_tl", "FACEBOOK_POST_AD_TL", "facebook_link", "FACEBOOK_LINK", "facebook_text_link", "FACEBOOK_TEXT_LINK", "facebook_text", "FACEBOOK_TEXT", "facebook_other", "FACEBOOK_OTHER", "facebook_other_text", "FACEBOOK_OTHER_TEXT", "facebook_other_tl", "FACEBOOK_OTHER_TL", "facebook_other_link", "FACEBOOK_OTHER_LINK", "twitter_owned", "TWITTER_OWNED", "twitter_owned_link", "TWITTER_OWNED_LINK", "twitter_owned_text", "TWITTER_OWNED_TEXT", "twitter_ugc", "TWITTER_UGC", "twitter_ugc_link", "TWITTER_UGC_LINK", "twitter_ugc_text", "TWITTER_UGC_TEXT", "twitter_other", "TWITTER_OTHER", "twitter_other_link", "TWITTER_OTHER_LINK", "twitter_other_text", "TWITTER_OTHER_TEXT", "tiktok_owned", "TIKTOK_OWNED", "tiktok_ugc", "TIKTOK_UGC", "tiktok_other", "TIKTOK_OTHER", "tiktok_ad_owned", "TIKTOK_AD_OWNED", "youtube_owned", "YOUTUBE_OWNED", "youtube_ugc", "YOUTUBE_UGC", "youtube_other", "YOUTUBE_OTHER", "linkedin_owned", "LINKEDIN_OWNED", "threads_owned", "THREADS_OWNED", "snapchat_owned_story", "SNAPCHAT_OWNED_STORY", "snapchat_owned_saved_story", "SNAPCHAT_OWNED_SAVED_STORY", "snapchat_owned_spotlight", "SNAPCHAT_OWNED_SPOTLIGHT", "snapchat_owned_snap", "SNAPCHAT_OWNED_SNAP", null ], "nullable": true, "type": "string" }, "type": "array" }, "style": "form" }, { "in": "query", "name": "type", "required": false, "schema": { "default": null, "enum": [ "image", "IMAGE", "video", "VIDEO", "other", "OTHER", null ], "nullable": true, "type": "string" } }, { "in": "query", "name": "aspect_ratio", "required": false, "schema": { "default": null, "enum": [ "square", "SQUARE", "landscape", "LANDSCAPE", "portrait", "PORTRAIT", null ], "nullable": true, "type": "string" } }, { "in": "query", "name": "rights_reqd", "required": false, "schema": { "default": null, "nullable": true, "type": "boolean" } }, { "in": "query", "name": "size", "required": false, "schema": { "default": null, "enum": [ "800x600", "800X600", "1024x768", "1024X768", "1600x1200", "1600X1200", null ], "nullable": true, "type": "string" } }, { "in": "query", "name": "color", "required": false, "schema": { "default": null, "enum": [ "red", "RED", "orange", "ORANGE", "yellow", "YELLOW", "green", "GREEN", "cyan", "CYAN", "blue", "BLUE", "purple", "PURPLE", "pink", "PINK", "brown", "BROWN", "black", "BLACK", "gray", "GRAY", "white", "WHITE", null ], "nullable": true, "type": "string" } }, { "in": "query", "name": "date_from", "required": false, "schema": { "default": null, "format": "date", "nullable": true, "type": "string" } }, { "in": "query", "name": "date_to", "required": false, "schema": { "default": null, "format": "date", "nullable": true, "type": "string" } }, { "in": "query", "name": "performance_from", "required": false, "schema": { "default": null, "nullable": true, "type": "number" } }, { "in": "query", "name": "performance_to", "required": false, "schema": { "default": null, "nullable": true, "type": "number" } }, { "in": "query", "name": "prediction_model", "required": false, "schema": { "default": "eng", "enum": [ "eng", "ENG", "fb_effec", "FB_EFFEC", "eng_scaled", "ENG_SCALED", "fb_lcr", "FB_LCR", "fb_lcr_cv", "FB_LCR_CV" ], "type": "string" } }, { "in": "query", "name": "sort", "required": false, "schema": { "default": null, "enum": [ "date", "DATE", "reach", "REACH", "performance", "PERFORMANCE", "relevance", "RELEVANCE", null ], "nullable": true, "type": "string" } }, { "in": "query", "name": "page", "required": false, "schema": { "default": null, "nullable": true, "type": "integer" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "type": "integer" } }, { "description": "Next token for getting past 10000 results containing score and media id", "explode": false, "in": "query", "name": "next_token", "required": false, "schema": { "example": [ "0.10000001", "321321321" ], "items": { "type": "string" }, "type": "array" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaSearchBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/MediaSearchResult" }, "type": "array" } } }, "description": "OK" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "tags": [ "MediaSearch" ] }, "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "format": "int32", "type": "integer" } } ], "put": { "parameters": [ { "in": "query", "name": "query", "required": false, "schema": { "default": null, "nullable": true, "type": "string" } }, { "in": "query", "name": "media_id", "required": false, "schema": { "default": null, "nullable": true, "type": "integer" } }, { "in": "query", "name": "image_data", "required": false, "schema": { "default": false, "nullable": true, "type": "boolean" } }, { "description": "list of brand media types", "explode": false, "in": "query", "name": "sources", "required": false, "schema": { "example": [ "INSTAGRAM_OWNED", "INSTAGRAM_OWNED_IGTV" ], "items": { "enum": [ "instagram_owned", "INSTAGRAM_OWNED", "instagram_ugc", "INSTAGRAM_UGC", "instagram_other", "INSTAGRAM_OTHER", "instagram_owned_igtv", "INSTAGRAM_OWNED_IGTV", "instagram_ugc_igtv", "INSTAGRAM_UGC_IGTV", "instagram_other_igtv", "INSTAGRAM_OTHER_IGTV", "instagram_story", "INSTAGRAM_STORY", "instagram_story_ugc", "INSTAGRAM_STORY_UGC", "instagram_ads", "INSTAGRAM_ADS", "uploaded", "UPLOADED", "edited", "EDITED", "ai_generated", "AI_GENERATED", "pinterest_owned", "PINTEREST_OWNED", "pinterest_story", "PINTEREST_STORY", "pinterest_ugc", "PINTEREST_UGC", "facebook_owned", "FACEBOOK_OWNED", "facebook_ads", "FACEBOOK_ADS", "facebook_post_ad", "FACEBOOK_POST_AD", "facebook_post_ad_l", "FACEBOOK_POST_AD_L", "facebook_post_ad_t", "FACEBOOK_POST_AD_T", "facebook_post_ad_tl", "FACEBOOK_POST_AD_TL", "facebook_link", "FACEBOOK_LINK", "facebook_text_link", "FACEBOOK_TEXT_LINK", "facebook_text", "FACEBOOK_TEXT", "facebook_other", "FACEBOOK_OTHER", "facebook_other_text", "FACEBOOK_OTHER_TEXT", "facebook_other_tl", "FACEBOOK_OTHER_TL", "facebook_other_link", "FACEBOOK_OTHER_LINK", "twitter_owned", "TWITTER_OWNED", "twitter_owned_link", "TWITTER_OWNED_LINK", "twitter_owned_text", "TWITTER_OWNED_TEXT", "twitter_ugc", "TWITTER_UGC", "twitter_ugc_link", "TWITTER_UGC_LINK", "twitter_ugc_text", "TWITTER_UGC_TEXT", "twitter_other", "TWITTER_OTHER", "twitter_other_link", "TWITTER_OTHER_LINK", "twitter_other_text", "TWITTER_OTHER_TEXT", "tiktok_owned", "TIKTOK_OWNED", "tiktok_ugc", "TIKTOK_UGC", "tiktok_other", "TIKTOK_OTHER", "tiktok_ad_owned", "TIKTOK_AD_OWNED", "youtube_owned", "YOUTUBE_OWNED", "youtube_ugc", "YOUTUBE_UGC", "youtube_other", "YOUTUBE_OTHER", "linkedin_owned", "LINKEDIN_OWNED", "threads_owned", "THREADS_OWNED", "snapchat_owned_story", "SNAPCHAT_OWNED_STORY", "snapchat_owned_saved_story", "SNAPCHAT_OWNED_SAVED_STORY", "snapchat_owned_spotlight", "SNAPCHAT_OWNED_SPOTLIGHT", "snapchat_owned_snap", "SNAPCHAT_OWNED_SNAP", null ], "nullable": true, "type": "string" }, "type": "array" }, "style": "form" }, { "in": "query", "name": "type", "required": false, "schema": { "default": null, "enum": [ "image", "IMAGE", "video", "VIDEO", "other", "OTHER", null ], "nullable": true, "type": "string" } }, { "in": "query", "name": "aspect_ratio", "required": false, "schema": { "default": null, "enum": [ "square", "SQUARE", "landscape", "LANDSCAPE", "portrait", "PORTRAIT", null ], "nullable": true, "type": "string" } }, { "in": "query", "name": "rights_reqd", "required": false, "schema": { "default": null, "nullable": true, "type": "boolean" } }, { "in": "query", "name": "size", "required": false, "schema": { "default": null, "enum": [ "800x600", "800X600", "1024x768", "1024X768", "1600x1200", "1600X1200", null ], "nullable": true, "type": "string" } }, { "in": "query", "name": "color", "required": false, "schema": { "default": null, "enum": [ "red", "RED", "orange", "ORANGE", "yellow", "YELLOW", "green", "GREEN", "cyan", "CYAN", "blue", "BLUE", "purple", "PURPLE", "pink", "PINK", "brown", "BROWN", "black", "BLACK", "gray", "GRAY", "white", "WHITE", null ], "nullable": true, "type": "string" } }, { "in": "query", "name": "date_from", "required": false, "schema": { "default": null, "format": "date", "nullable": true, "type": "string" } }, { "in": "query", "name": "date_to", "required": false, "schema": { "default": null, "format": "date", "nullable": true, "type": "string" } }, { "in": "query", "name": "performance_from", "required": false, "schema": { "default": null, "nullable": true, "type": "number" } }, { "in": "query", "name": "performance_to", "required": false, "schema": { "default": null, "nullable": true, "type": "number" } }, { "in": "query", "name": "prediction_model", "required": false, "schema": { "default": "eng", "enum": [ "eng", "ENG", "fb_effec", "FB_EFFEC", "eng_scaled", "ENG_SCALED", "fb_lcr", "FB_LCR", "fb_lcr_cv", "FB_LCR_CV" ], "type": "string" } }, { "in": "query", "name": "sort", "required": false, "schema": { "default": null, "enum": [ "date", "DATE", "reach", "REACH", "performance", "PERFORMANCE", "relevance", "RELEVANCE", null ], "nullable": true, "type": "string" } }, { "in": "query", "name": "page", "required": false, "schema": { "default": null, "nullable": true, "type": "integer" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "type": "integer" } }, { "description": "Next token for getting past 10000 results containing score and media id", "explode": false, "in": "query", "name": "next_token", "required": false, "schema": { "example": [ "0.10000001", "321321321" ], "items": { "type": "string" }, "type": "array" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaSearchBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/MediaSearchResult" }, "type": "array" } } }, "description": "OK" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "tags": [ "MediaSearch" ] } }, "/brands/{brand_id}/product_catalog": { "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "minimum": 0, "type": "integer" } } ], "post": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateProductCatalogRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductCatalog" } } }, "description": "OK" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Create a Product Catalog resource", "tags": [ "Product Catalog" ] } }, "/brands/{brand_id}/product_feeds": { "get": { "parameters": [ { "description": "Number of results to return in a single response.", "in": "query", "name": "limit", "required": false, "schema": { "default": 100, "maximum": 1000, "minimum": 0, "type": "integer" } }, { "description": "The offset of the first result to be returned.", "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "minimum": 0, "type": "integer" } }, { "description": "Sort by field. \"-\" for descending.", "in": "query", "name": "sort", "required": false, "schema": { "enum": [ "ARCHIVED", "-ARCHIVED", null ], "nullable": true, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductFeeds" } } }, "description": "OK" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Return a list of a brand's product feeds", "tags": [ "Product Feed" ] }, "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "minimum": 0, "type": "integer" } } ], "post": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductFeedCreateRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductFeed" } } }, "description": "Created" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Create a product feed for a brand", "tags": [ "Product Feed" ], "x-public": true } }, "/brands/{brand_id}/product_feeds/{feed_id}": { "delete": { "responses": { "204": { "description": "No Content" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Delete a brand's product feed", "tags": [ "Product Feed" ], "x-public": true }, "get": { "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductFeed" } } }, "description": "OK" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Retrieve a product feed", "tags": [ "Product Feed" ], "x-public": true, "description": "Returns a brand's product feed by ID." }, "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "minimum": 0, "type": "integer" } }, { "description": "The Dash Social assigned ID of the Product Feed.", "in": "path", "name": "feed_id", "required": true, "schema": { "minimum": 0, "type": "integer" } } ], "patch": { "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductFeed" } } }, "description": "OK" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Update a brand's product feed", "tags": [ "Product Feed" ], "x-public": true } }, "/brands/{brand_id}/product_feeds/{feed_id}/products/archive": { "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "minimum": 0, "type": "integer" } }, { "description": "The Dash Social assigned ID of the Product Feed.", "in": "path", "name": "feed_id", "required": true, "schema": { "minimum": 0, "type": "integer" } } ], "patch": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductFeedArchiveRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Archive or un-archive all products belonging to a product feed", "tags": [ "Product Feed" ] } }, "/brands/{brand_id}/product_feeds/{feed_id}/update": { "get": { "responses": { "200": { "description": "OK" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Initiate a product feed update", "tags": [ "Product Feed" ] }, "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "minimum": 0, "type": "integer" } }, { "description": "The Dash Social assigned ID of the Product Feed.", "in": "path", "name": "feed_id", "required": true, "schema": { "minimum": 0, "type": "integer" } } ] }, "/brands/{brand_id}/products/archive": { "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "format": "int32", "type": "integer" } } ], "patch": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkUpdateProductsRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RowsAffected" } } }, "description": "OK" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Archive products", "tags": [ "Product" ], "x-public": true, "description": "Updates the archived status of a list of products." } }, "/brands/{brand_id}/products/find_by_url": { "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "format": "int32", "type": "integer" } } ], "post": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchProductRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Product" } } }, "description": "OK" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Search Brand's product catalog by URL, and return a single, exact matched product\nWill also search product_overrides", "tags": [ "Product" ] } }, "/brands/{brand_id}/products/media": { "get": { "parameters": [ { "description": "Source ID of the product (SKU or brand's product ID).", "in": "query", "name": "product_source_id", "required": false, "schema": { "type": "string" } }, { "description": "Request true if there are multiple product rows with the same source_id, otherwise only the first will be returned.", "in": "query", "name": "multiple_by_source_id", "required": false, "schema": { "default": false, "type": "boolean" } }, { "description": "Source ID of the catalog/collection the product belongs to.", "in": "query", "name": "product_source_group_id", "required": false, "schema": { "type": "string" } }, { "description": "Request true to order results by the most recent source media created date.", "in": "query", "name": "sort_by_source_created", "required": false, "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/BrandMediaWithProducts" }, "type": "array" } } }, "description": "OK" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "tags": [ "Product" ], "x-public": true, "summary": "Retrieve product media", "description": "Returns media associated with products for a brand." }, "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "format": "int32", "type": "integer" } } ] }, "/brands/{brand_id}/refresh_index": { "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "format": "int32", "type": "integer" } } ], "post": { "parameters": [ { "description": "The period of time, in days, of the recent media to refresh. If not specified, all media are refreshed.", "in": "query", "name": "days_back", "required": false, "schema": { "default": null, "nullable": true, "type": "integer" } }, { "description": "Whether to delete all the existing indexed media records of the brand. ", "in": "query", "name": "remove_previous", "required": false, "schema": { "default": false, "type": "boolean" } }, { "description": "Comma-separated list of media types want to be reindexed.", "explode": false, "in": "query", "name": "media_types", "required": false, "schema": { "example": [ "INSTAGRAM_OWNED", "INSTAGRAM_UGC" ], "items": { "enum": [ "INSTAGRAM_OWNED", "INSTAGRAM_UGC", "INSTAGRAM_OTHER", "INSTAGRAM_OWNED_IGTV", "INSTAGRAM_UGC_IGTV", "INSTAGRAM_OTHER_IGTV", "INSTAGRAM_STORY", "INSTAGRAM_STORY_UGC", "INSTAGRAM_ADS", "UPLOADED", "EDITED", "AI_GENERATED", "PINTEREST_OWNED", "PINTEREST_STORY", "PINTEREST_UGC", "FACEBOOK_OWNED", "FACEBOOK_ADS", "FACEBOOK_POST_AD", "FACEBOOK_POST_AD_L", "FACEBOOK_POST_AD_T", "FACEBOOK_POST_AD_TL", "FACEBOOK_LINK", "FACEBOOK_TEXT_LINK", "FACEBOOK_TEXT", "FACEBOOK_OTHER", "FACEBOOK_OTHER_TEXT", "FACEBOOK_OTHER_TL", "FACEBOOK_OTHER_LINK", "TWITTER_OWNED", "TWITTER_OWNED_LINK", "TWITTER_OWNED_TEXT", "TWITTER_UGC", "TWITTER_UGC_LINK", "TWITTER_UGC_TEXT", "TWITTER_OTHER", "TWITTER_OTHER_LINK", "TWITTER_OTHER_TEXT", "TIKTOK_OWNED", "TIKTOK_UGC", "TIKTOK_OTHER", "TIKTOK_AD_OWNED", "YOUTUBE_OWNED", "YOUTUBE_UGC", "YOUTUBE_OTHER", "LINKEDIN_OWNED", "THREADS_OWNED", "SNAPCHAT_OWNED_STORY", "SNAPCHAT_OWNED_SAVED_STORY", "SNAPCHAT_OWNED_SPOTLIGHT", "SNAPCHAT_OWNED_SNAP" ], "type": "string" }, "type": "array" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatusOK" } } }, "description": "OK" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Reindex the posts for brand.", "tags": [ "Admin" ] } }, "/brands/{brand_id}/segment_cluster_tag_associations": { "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "format": "int32", "type": "integer" } } ], "post": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSegmentClusterTagAssociationsRequest" } } }, "required": true }, "responses": { "201": { "description": "Created" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "tags": [ "SegmentClusterTagAssociations" ] } }, "/brands/{brand_id}/segment_cluster_tags": { "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "format": "int32", "type": "integer" } } ], "post": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSegmentClusterTagRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SegmentClusterTag" } } }, "description": "Created" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "tags": [ "SegmentClusterTags" ] } }, "/brands/{brand_id}/segment_cluster_tags/{segment_cluster_tag_id}": { "delete": { "responses": { "204": { "description": "No Content" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "tags": [ "SegmentClusterTags" ] }, "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "format": "int32", "type": "integer" } }, { "description": "The ID of the segment cluster tag.", "in": "path", "name": "segment_cluster_tag_id", "required": true, "schema": { "format": "int32", "type": "integer" } } ] }, "/brands/{brand_id}/timeseries_metrics/instagram_story": { "get": { "parameters": [ { "description": "Scale of aggregated metrics", "in": "query", "name": "scale", "required": true, "schema": { "enum": [ "DAILY", "MONTHLY" ], "type": "string" } }, { "description": "Start date of time range", "in": "query", "name": "start_date", "required": false, "schema": { "example": "2020-01-01", "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(Z|((\\+|-)\\d{2}:\\d{2})))?$", "type": "string" } }, { "description": "End date of time range", "in": "query", "name": "end_date", "required": false, "schema": { "example": "2020-12-31", "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(Z|((\\+|-)\\d{2}:\\d{2})))?$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InstagramStoryTimeseriesMetrics" } } }, "description": "OK" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Aggregate Instagram Story metrics by a given time range and scale.", "tags": [ "MediaTimeseriesMetrics" ] }, "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "format": "int32", "type": "integer" } } ] }, "/brands/{brand_id}/utm_settings": { "delete": { "responses": { "204": { "description": "No Content" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "tags": [ "UTMSettings" ] }, "get": { "parameters": [ { "description": "The channel, one of likeshop_instagram, likeshop_tiktok, instagram_story, facebook, twitter, pinterest", "in": "query", "name": "channel", "required": false, "schema": { "enum": [ "facebook", "instagram_story", "likeshop_instagram", "likeshop_tiktok", "pinterest", "twitter" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UtmSettingsCreateUpdate" } } }, "description": "OK" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "tags": [ "UTMSettings" ] }, "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "format": "int32", "type": "integer" } } ], "put": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UtmSettingsCreateUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UtmSettingsCreateUpdate" } } }, "description": "OK" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "tags": [ "UTMSettings" ] } }, "/brands/{brand_id}/utm_settings/decode_utms": { "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "format": "int32", "type": "integer" } } ], "post": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UtmSettingsDecodeUtms" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UtmSettingsDecodeUtmsResponse" } } }, "description": "OK" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "tags": [ "UTMSettings" ] } }, "/brands/{brand_id}/utm_settings/encode_utms": { "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "format": "int32", "type": "integer" } } ], "post": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UtmEncodePost" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UtmEncodedPostResponse" } } }, "description": "OK" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "tags": [ "UTMSettings" ] } }, "/brands/{brand_id}/utm_settings/preset_values": { "get": { "parameters": [ { "description": "The tracking key to filter by", "in": "query", "name": "tracking_key", "required": false, "schema": { "type": "string" } }, { "description": "The channel to filter by", "in": "query", "name": "channel", "required": true, "schema": { "enum": [ "likeshop_instagram", "likeshop_tiktok", "shoppable_gallery", "product_page_gallery", "instagram_story", "facebook", "twitter", "pinterest" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/UtmPresetValueResponse" }, "type": "array" } } }, "description": "OK" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "tags": [ "UTMSettings" ] }, "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "format": "int32", "type": "integer" } } ], "post": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UtmPresetValueCreate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UtmPresetValueResponse" } } }, "description": "OK" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "tags": [ "UTMSettings" ] } }, "/brands/{brand_id}/utm_settings/preset_values/{preset_value_id}": { "delete": { "responses": { "204": { "description": "No Content" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "tags": [ "UTMSettings" ] }, "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "format": "int32", "type": "integer" } }, { "description": "ID of the preset value.", "in": "path", "name": "preset_value_id", "required": true, "schema": { "format": "int32", "type": "integer" } } ], "put": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UtmPresetValueUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UtmPresetValueResponse" } } }, "description": "OK" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "tags": [ "UTMSettings" ] } }, "/brands/{brand_id}/video_generation/usage": { "get": { "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VideoGenerationUsageResponse" } } }, "description": "OK" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "tags": [ "VideoGeneration" ] }, "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "format": "int32", "type": "integer" } } ] }, "/competitors/search": { "post": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompetitorSearch" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/CompetitorSearchResponse" }, "type": "array" } } }, "description": "OK" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Search for competitors by source channel.", "tags": [ "CompetitorsSearch" ] } }, "/content_automations/search": { "post": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentAutomationSearch" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentAutomationSearchResult" } } }, "description": "OK" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "tags": [ "Content Automations Cross Organization" ] } }, "/custom_metric/reindex": { "post": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReindexBrandPostsCustomMetrics" } } }, "required": true }, "responses": { "202": { "description": "Accepted" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "tags": [ "Custom Metrics" ] } }, "/media": { "post": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateMediaForManyBrandsRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "tags": [ "MediaV1" ] } }, "/media/bulk": { "delete": { "parameters": [ { "description": "Comma-separated list of brand IDs.", "explode": false, "in": "query", "name": "brand_ids", "required": true, "schema": { "items": { "type": "integer" }, "type": "array" }, "style": "form" }, { "description": "Comma-separated list of media IDs.", "explode": false, "in": "query", "name": "media_ids", "required": true, "schema": { "items": { "type": "integer" }, "type": "array" }, "style": "form" } ], "responses": { "204": { "description": "No Content" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "tags": [ "MediaV1" ] } }, "/media/bulk_hard_delete": { "delete": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkHardDeleteMediaRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkHardDeleteMediaResponse" } } }, "description": "OK" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "tags": [ "MediaV1" ] } }, "/media/instagram_hashtag_media/hard_delete": { "delete": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HardDeleteMediaBySourceIdRequest" } } }, "required": true }, "responses": { "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Hard delete Instagram Hashtag media by source_id(s).\nAccepts a single source_id or a list of source_ids for bulk deletion.\nThis endpoint requires a secret for authorization, only operates on media with\na source of 'INSTAGRAM' and source_id(s) starting with '11' (Instagram hashtag media).\nIt deletes the media from the database, removes associated S3 files, and cleans up\nall related media and brand media dependencies.", "tags": [ "MediaV1" ] } }, "/media/search": { "post": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchMediaMultiBrand" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaV2List" } } }, "description": "OK" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "tags": [ "MediaV1" ] } }, "/organizations/{organization_id}/brand_media_content_tags": { "parameters": [ { "description": "The Dash Social assigned ID of the organization.", "in": "path", "name": "organization_id", "required": true, "schema": { "format": "int32", "type": "integer" } } ], "post": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrandMediaContentTagCreate" } } }, "required": true }, "responses": { "201": { "description": "Created" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "tags": [ "BrandMediaContentTags" ] } }, "/organizations/{organization_id}/content_automations": { "parameters": [ { "description": "The Dash Social assigned ID of the organization.", "in": "path", "name": "organization_id", "required": true, "schema": { "format": "int32", "type": "integer" } } ], "post": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentAutomationCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentAutomation" } } }, "description": "Created" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "tags": [ "Content Automations" ] } }, "/organizations/{organization_id}/content_automations/brand_prompt_count": { "get": { "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentAutomationBrandPromptCountResponse" } } }, "description": "OK" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "tags": [ "Content Automations" ] }, "parameters": [ { "description": "The Dash Social assigned ID of the organization.", "in": "path", "name": "organization_id", "required": true, "schema": { "format": "int32", "type": "integer" } } ] }, "/organizations/{organization_id}/content_automations/match_count": { "parameters": [ { "description": "The Dash Social assigned ID of the organization.", "in": "path", "name": "organization_id", "required": true, "schema": { "format": "int32", "type": "integer" } } ], "post": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentAutomationCountMatchingMedia" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentAutomationCountMatchingMediaResponse" } } }, "description": "OK" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "tags": [ "Content Automations" ] } }, "/organizations/{organization_id}/content_automations/preview": { "parameters": [ { "description": "The Dash Social assigned ID of the organization.", "in": "path", "name": "organization_id", "required": true, "schema": { "format": "int32", "type": "integer" } } ], "post": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentAutomationPreviewRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentAutomationPreviewResponse" } } }, "description": "OK" }, "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentAutomationPreviewGeneratingResponse" } } }, "description": "Accepted" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "tags": [ "Content Automations" ] } }, "/organizations/{organization_id}/content_automations/{content_automation_id}": { "delete": { "responses": { "204": { "description": "No Content" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "tags": [ "Content Automations" ] }, "parameters": [ { "description": "The Dash Social assigned ID of the organization.", "in": "path", "name": "organization_id", "required": true, "schema": { "format": "int32", "type": "integer" } }, { "description": "The Dash Social assinged ID of the content automation.", "in": "path", "name": "content_automation_id", "required": true, "schema": { "format": "int32", "type": "integer" } } ], "patch": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentAutomationUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentAutomation" } } }, "description": "OK" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "tags": [ "Content Automations" ] } }, "/organizations/{organization_id}/content_automations/{content_automation_id}/run": { "parameters": [ { "description": "The Dash Social assigned ID of the organization.", "in": "path", "name": "organization_id", "required": true, "schema": { "format": "int32", "type": "integer" } }, { "description": "The Dash Social assinged ID of the content automation.", "in": "path", "name": "content_automation_id", "required": true, "schema": { "format": "int32", "type": "integer" } } ], "post": { "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunContentAutomationResponse" } } }, "description": "Accepted" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "tags": [ "Content Automations" ] } }, "/organizations/{organization_id}/content_tags": { "get": { "parameters": [ { "description": "Comma-separated list of content tag IDs to return.", "explode": false, "in": "query", "name": "ids", "required": false, "schema": { "items": { "type": "integer" }, "minItems": 1, "type": "array" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ContentTag" }, "type": "array" } } }, "description": "OK" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "tags": [ "ContentTags" ], "summary": "Retrieve content tags", "description": "Returns a list of content tags for an organization." }, "parameters": [ { "description": "The Dash Social assigned ID of the organization.", "in": "path", "name": "organization_id", "required": true, "schema": { "format": "int32", "type": "integer" } } ], "post": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentTagCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentTag" } } }, "description": "Created" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "tags": [ "ContentTags" ], "summary": "Create a content tag", "description": "Creates a new content tag for an organization." } }, "/organizations/{organization_id}/content_tags/{content_tag_id}": { "delete": { "responses": { "204": { "description": "No Content" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "tags": [ "ContentTags" ] }, "parameters": [ { "description": "The Dash Social assigned ID of the organization.", "in": "path", "name": "organization_id", "required": true, "schema": { "format": "int32", "type": "integer" } }, { "description": "The Dash Social assigned ID of the content tag.", "in": "path", "name": "content_tag_id", "required": true, "schema": { "format": "int32", "type": "integer" } } ], "patch": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentTagUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentTag" } } }, "description": "OK" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "tags": [ "ContentTags" ] } }, "/organizations/{organization_id}/content_tags/{content_tag_id}/brand_media/{brand_media_id}": { "delete": { "responses": { "204": { "description": "No Content" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "tags": [ "ContentTags" ] }, "parameters": [ { "description": "The Dash Social assigned ID of the organization.", "in": "path", "name": "organization_id", "required": true, "schema": { "format": "int32", "type": "integer" } }, { "description": "The Dash Social assigned ID of the content tag.", "in": "path", "name": "content_tag_id", "required": true, "schema": { "format": "int32", "type": "integer" } }, { "description": "The Dash Social assigned ID of the brand media.", "in": "path", "name": "brand_media_id", "required": true, "schema": { "format": "int32", "type": "integer" } } ] }, "/organizations/{organization_id}/content_tags/{content_tag_id}/brands/{brand_id}": { "delete": { "responses": { "204": { "description": "No Content" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "tags": [ "ContentTags" ] }, "parameters": [ { "description": "The Dash Social assigned ID of the organization.", "in": "path", "name": "organization_id", "required": true, "schema": { "format": "int32", "type": "integer" } }, { "description": "The Dash Social assigned ID of the content tag.", "in": "path", "name": "content_tag_id", "required": true, "schema": { "format": "int32", "type": "integer" } }, { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "format": "int32", "type": "integer" } } ] }, "/public/brands/{brand_id}/galleries/{gallery_id}/media": { "get": { "parameters": [ { "description": "Sort by field. \"-\" for descending.", "in": "query", "name": "sort", "required": false, "schema": { "enum": [ "PUBLISHED_AT", "CREATED", "UPDATED", "ORDER", "VISITS", "ADDED", "POSTED", "CLICKS", "LIKESHOP_CLICKS", "PERFORMANCE", "VIDEO_VIEWS", "AVERAGE_VIDEO_WATCH_TIME", "INSTAGRAM_EFFECTIVENESS", "INSTAGRAM_REACH", "INSTAGRAM_ENGAGEMENT", "INSTAGRAM_ORGANIC_COMMENTS", "INSTAGRAM_PAID_COMMENTS", "INSTAGRAM_TOTAL_COMMENTS", "INSTAGRAM_ENGAGEMENT_RATE", "INSTAGRAM_ENGAGEMENT_RATE_VIEWS", "INSTAGRAM_ORGANIC_IMPRESSIONS", "INSTAGRAM_PAID_IMPRESSIONS", "INSTAGRAM_TOTAL_IMPRESSIONS", "INSTAGRAM_ORGANIC_LIKES", "INSTAGRAM_PAID_LIKES", "INSTAGRAM_TOTAL_LIKES", "INSTAGRAM_SAVES", "INSTAGRAM_TOTAL_ENGAGEMENTS", "INSTAGRAM_PAID_TOTAL_ENGAGEMENTS", "INSTAGRAM_SUM_TOTAL_ENGAGEMENTS", "INSTAGRAM_VIDEO_VIEWS", "INSTAGRAM_PAID_VIDEO_VIEWS", "INSTAGRAM_TOTAL_VIDEO_VIEWS", "INSTAGRAM_PAID_ENGAGEMENT_RATE", "INSTAGRAM_TOTAL_WATCH_TIME", "INSTAGRAM_STORY_REACH", "INSTAGRAM_STORY_IMPRESSIONS", "INSTAGRAM_STORY_SWIPE_UPS", "INSTAGRAM_STORY_REPLIES", "INSTAGRAM_STORY_EXIT_RATE", "PINTEREST_CLICKS", "PINTEREST_CLOSEUPS", "PINTEREST_COMMENTS", "PINTEREST_ENGAGEMENT", "PINTEREST_IMPRESSIONS", "PINTEREST_SAVES", "PINTEREST_VIDEO_VIEWS", "PINTEREST_AVERAGE_VIDEO_WATCH_TIME", "PINTEREST_ENGAGEMENTS", "DATE", "INSTAGRAM_STORY_FRAME_REACH", "INSTAGRAM_STORY_FRAME_IMPRESSIONS", "INSTAGRAM_STORY_FRAME_COMPLETION_RATE", "INSTAGRAM_STORY_FRAME_EXITS", "INSTAGRAM_STORY_FRAME_EXIT_RATE", "INSTAGRAM_STORY_FRAME_SWIPE_UPS", "INSTAGRAM_STORY_FRAME_REPLIES", "INSTAGRAM_STORY_FRAME_TAPS_BACK", "INSTAGRAM_STORY_FRAME_TAPS_FORWARD", "FACEBOOK_PHOTO_VIEW_CLICKS", "FACEBOOK_POST_CLICKS", "FACEBOOK_COMMENTS", "FACEBOOK_REACH", "FACEBOOK_EFFECTIVENESS", "FACEBOOK_REACTIONS", "FACEBOOK_ENGAGEMENT_RATE", "FACEBOOK_ENGAGEMENT_RATE_PUBLIC", "FACEBOOK_SHARES", "FACEBOOK_IMPRESSIONS", "FACEBOOK_TOTAL_ENGAGEMENTS", "FACEBOOK_TOTAL_ENGAGEMENTS_PUBLIC", "FACEBOOK_LINK_CLICKS", "FACEBOOK_VIDEO_COMPLETE_VIEWS", "FACEBOOK_OTHER_CLICKS", "FACEBOOK_VIDEO_VIEWS", "FACEBOOK_REELS_POST_VIDEO_VIEW_TIME", "FACEBOOK_REELS_POST_IMPRESSIONS_UNIQUE", "TWITTER_ENGAGEMENT_RATE", "TWITTER_IMPRESSIONS", "TWITTER_URL_CLICKS", "TWITTER_USER_PROFILE_CLICKS", "TWITTER_QUOTE_TWEETS", "TWITTER_REPLIES", "TWITTER_RETWEETS", "TWITTER_TOTAL_ENGAGEMENTS", "TWITTER_TOTAL_RETWEETS", "TWITTER_FOLLOWS", "TWITTER_VIDEO_VIEWS", "TIKTOK_REACH", "TIKTOK_AVERAGE_TIME_WATCHED", "TIKTOK_AVERAGE_COMPLETION_RATE", "TIKTOK_COMMENTS", "TIKTOK_IMPRESSIONS_SEARCH_RATE", "TIKTOK_FULL_VIDEO_WATCHED_RATE", "TIKTOK_SHARES", "TIKTOK_ENGAGEMENT_RATE", "TIKTOK_ENTERTAINMENT_SCORE", "TIKTOK_IMPRESSIONS_SOUND_RATE", "TIKTOK_IMPRESSIONS_FOLLOW_RATE", "TIKTOK_TOTAL_ENGAGEMENTS", "TIKTOK_IMPRESSIONS_FOR_YOU_RATE", "TIKTOK_TOTAL_TIME_WATCHED", "TIKTOK_IMPRESSIONS_HASHTAG_RATE", "TIKTOK_DURATION", "TIKTOK_LIKES", "TIKTOK_VIEWS", "TIKTOK_IMPRESSIONS_PERSONAL_PROFILE_RATE", "YOUTUBE_AVG_VIEW_PERCENTAGE", "YOUTUBE_AVG_VIEW_DURATION", "YOUTUBE_CARD_IMPRESSIONS", "YOUTUBE_CARD_CLICKS", "YOUTUBE_CARD_CLICK_RATE", "YOUTUBE_CARD_TEASER_CLICKS", "YOUTUBE_CARD_TEASER_CLICK_RATE", "YOUTUBE_CARD_TEASER_IMPRESSIONS", "YOUTUBE_COMMENTS", "YOUTUBE_DISLIKES", "YOUTUBE_LIKES", "YOUTUBE_PREMIUM_VIEWS", "YOUTUBE_EST_PREMIUM_SECONDS_WATCHED", "YOUTUBE_SHARES", "YOUTUBE_SUBSCRIBERS", "YOUTUBE_ENGAGEMENTS", "YOUTUBE_VIDEOS_ADDED_TO_PLAYLIST", "YOUTUBE_VIEWS", "YOUTUBE_EST_SECONDS_WATCHED", "LINKEDIN_CLICK_THROUGH_RATE", "LINKEDIN_CLICKS", "LINKEDIN_COMMENTS", "LINKEDIN_ENGAGEMENTS", "LINKEDIN_ENGAGEMENT_RATE", "LINKEDIN_IMPRESSIONS", "LINKEDIN_LIKES", "LINKEDIN_SHARES", "LINKEDIN_UNIQUE_IMPRESSIONS", "LINKEDIN_VIDEO_ANALYTICS_VIDEO_VIEWS", "LINKEDIN_VIDEO_ANALYTICS_TIME_WATCHED_FOR_VIEWS", "THREADS_ENGAGEMENTS", "THREADS_ENGAGEMENT_RATE", "THREADS_LIKES", "THREADS_QUOTES", "THREADS_REPLIES", "THREADS_REPOSTS", "THREADS_REPOSTS_AND_QUOTES", "THREADS_SHARES", "THREADS_VIEWS", "SNAPCHAT_AVG_VIEW_TIME_SECONDS", "SNAPCHAT_COMPLETES", "SNAPCHAT_ENGAGEMENT_RATE", "SNAPCHAT_ENGAGEMENTS", "SNAPCHAT_FAVORITES", "SNAPCHAT_INTERACTIONS", "SNAPCHAT_REPLIES", "SNAPCHAT_SHARES", "SNAPCHAT_SWIPE_DOWNS", "SNAPCHAT_SWIPE_UPS", "SNAPCHAT_UNIQUE_SESSIONS", "SNAPCHAT_VIEW_TIME_SECONDS", "SNAPCHAT_VIEWERS", "SNAPCHAT_VIEWS", "-PUBLISHED_AT", "-CREATED", "-UPDATED", "-ORDER", "-VISITS", "-ADDED", "-POSTED", "-CLICKS", "-LIKESHOP_CLICKS", "-PERFORMANCE", "-VIDEO_VIEWS", "-AVERAGE_VIDEO_WATCH_TIME", "-INSTAGRAM_EFFECTIVENESS", "-INSTAGRAM_REACH", "-INSTAGRAM_ENGAGEMENT", "-INSTAGRAM_ORGANIC_COMMENTS", "-INSTAGRAM_PAID_COMMENTS", "-INSTAGRAM_TOTAL_COMMENTS", "-INSTAGRAM_ENGAGEMENT_RATE", "-INSTAGRAM_ENGAGEMENT_RATE_VIEWS", "-INSTAGRAM_ORGANIC_IMPRESSIONS", "-INSTAGRAM_PAID_IMPRESSIONS", "-INSTAGRAM_TOTAL_IMPRESSIONS", "-INSTAGRAM_ORGANIC_LIKES", "-INSTAGRAM_PAID_LIKES", "-INSTAGRAM_TOTAL_LIKES", "-INSTAGRAM_SAVES", "-INSTAGRAM_TOTAL_ENGAGEMENTS", "-INSTAGRAM_PAID_TOTAL_ENGAGEMENTS", "-INSTAGRAM_SUM_TOTAL_ENGAGEMENTS", "-INSTAGRAM_VIDEO_VIEWS", "-INSTAGRAM_PAID_VIDEO_VIEWS", "-INSTAGRAM_TOTAL_VIDEO_VIEWS", "-INSTAGRAM_PAID_ENGAGEMENT_RATE", "-INSTAGRAM_TOTAL_WATCH_TIME", "-INSTAGRAM_STORY_REACH", "-INSTAGRAM_STORY_IMPRESSIONS", "-INSTAGRAM_STORY_SWIPE_UPS", "-INSTAGRAM_STORY_REPLIES", "-INSTAGRAM_STORY_EXIT_RATE", "-PINTEREST_CLICKS", "-PINTEREST_CLOSEUPS", "-PINTEREST_COMMENTS", "-PINTEREST_ENGAGEMENT", "-PINTEREST_IMPRESSIONS", "-PINTEREST_SAVES", "-PINTEREST_VIDEO_VIEWS", "-PINTEREST_AVERAGE_VIDEO_WATCH_TIME", "-PINTEREST_ENGAGEMENTS", "-DATE", "-INSTAGRAM_STORY_FRAME_REACH", "-INSTAGRAM_STORY_FRAME_IMPRESSIONS", "-INSTAGRAM_STORY_FRAME_COMPLETION_RATE", "-INSTAGRAM_STORY_FRAME_EXITS", "-INSTAGRAM_STORY_FRAME_EXIT_RATE", "-INSTAGRAM_STORY_FRAME_SWIPE_UPS", "-INSTAGRAM_STORY_FRAME_REPLIES", "-INSTAGRAM_STORY_FRAME_TAPS_BACK", "-INSTAGRAM_STORY_FRAME_TAPS_FORWARD", "-FACEBOOK_PHOTO_VIEW_CLICKS", "-FACEBOOK_POST_CLICKS", "-FACEBOOK_COMMENTS", "-FACEBOOK_REACH", "-FACEBOOK_EFFECTIVENESS", "-FACEBOOK_REACTIONS", "-FACEBOOK_ENGAGEMENT_RATE", "-FACEBOOK_ENGAGEMENT_RATE_PUBLIC", "-FACEBOOK_SHARES", "-FACEBOOK_IMPRESSIONS", "-FACEBOOK_TOTAL_ENGAGEMENTS", "-FACEBOOK_TOTAL_ENGAGEMENTS_PUBLIC", "-FACEBOOK_LINK_CLICKS", "-FACEBOOK_VIDEO_COMPLETE_VIEWS", "-FACEBOOK_OTHER_CLICKS", "-FACEBOOK_VIDEO_VIEWS", "-FACEBOOK_REELS_POST_VIDEO_VIEW_TIME", "-FACEBOOK_REELS_POST_IMPRESSIONS_UNIQUE", "-TWITTER_ENGAGEMENT_RATE", "-TWITTER_IMPRESSIONS", "-TWITTER_URL_CLICKS", "-TWITTER_USER_PROFILE_CLICKS", "-TWITTER_QUOTE_TWEETS", "-TWITTER_REPLIES", "-TWITTER_RETWEETS", "-TWITTER_TOTAL_ENGAGEMENTS", "-TWITTER_TOTAL_RETWEETS", "-TWITTER_FOLLOWS", "-TWITTER_VIDEO_VIEWS", "-TIKTOK_REACH", "-TIKTOK_AVERAGE_TIME_WATCHED", "-TIKTOK_AVERAGE_COMPLETION_RATE", "-TIKTOK_COMMENTS", "-TIKTOK_IMPRESSIONS_SEARCH_RATE", "-TIKTOK_FULL_VIDEO_WATCHED_RATE", "-TIKTOK_SHARES", "-TIKTOK_ENGAGEMENT_RATE", "-TIKTOK_ENTERTAINMENT_SCORE", "-TIKTOK_IMPRESSIONS_SOUND_RATE", "-TIKTOK_IMPRESSIONS_FOLLOW_RATE", "-TIKTOK_TOTAL_ENGAGEMENTS", "-TIKTOK_IMPRESSIONS_FOR_YOU_RATE", "-TIKTOK_TOTAL_TIME_WATCHED", "-TIKTOK_IMPRESSIONS_HASHTAG_RATE", "-TIKTOK_DURATION", "-TIKTOK_LIKES", "-TIKTOK_VIEWS", "-TIKTOK_IMPRESSIONS_PERSONAL_PROFILE_RATE", "-YOUTUBE_AVG_VIEW_PERCENTAGE", "-YOUTUBE_AVG_VIEW_DURATION", "-YOUTUBE_CARD_IMPRESSIONS", "-YOUTUBE_CARD_CLICKS", "-YOUTUBE_CARD_CLICK_RATE", "-YOUTUBE_CARD_TEASER_CLICKS", "-YOUTUBE_CARD_TEASER_CLICK_RATE", "-YOUTUBE_CARD_TEASER_IMPRESSIONS", "-YOUTUBE_COMMENTS", "-YOUTUBE_DISLIKES", "-YOUTUBE_LIKES", "-YOUTUBE_PREMIUM_VIEWS", "-YOUTUBE_EST_PREMIUM_SECONDS_WATCHED", "-YOUTUBE_SHARES", "-YOUTUBE_SUBSCRIBERS", "-YOUTUBE_ENGAGEMENTS", "-YOUTUBE_VIDEOS_ADDED_TO_PLAYLIST", "-YOUTUBE_VIEWS", "-YOUTUBE_EST_SECONDS_WATCHED", "-LINKEDIN_CLICK_THROUGH_RATE", "-LINKEDIN_CLICKS", "-LINKEDIN_COMMENTS", "-LINKEDIN_ENGAGEMENTS", "-LINKEDIN_ENGAGEMENT_RATE", "-LINKEDIN_IMPRESSIONS", "-LINKEDIN_LIKES", "-LINKEDIN_SHARES", "-LINKEDIN_UNIQUE_IMPRESSIONS", "-LINKEDIN_VIDEO_ANALYTICS_VIDEO_VIEWS", "-LINKEDIN_VIDEO_ANALYTICS_TIME_WATCHED_FOR_VIEWS", "-THREADS_ENGAGEMENTS", "-THREADS_ENGAGEMENT_RATE", "-THREADS_LIKES", "-THREADS_QUOTES", "-THREADS_REPLIES", "-THREADS_REPOSTS", "-THREADS_REPOSTS_AND_QUOTES", "-THREADS_SHARES", "-THREADS_VIEWS", "-SNAPCHAT_AVG_VIEW_TIME_SECONDS", "-SNAPCHAT_COMPLETES", "-SNAPCHAT_ENGAGEMENT_RATE", "-SNAPCHAT_ENGAGEMENTS", "-SNAPCHAT_FAVORITES", "-SNAPCHAT_INTERACTIONS", "-SNAPCHAT_REPLIES", "-SNAPCHAT_SHARES", "-SNAPCHAT_SWIPE_DOWNS", "-SNAPCHAT_SWIPE_UPS", "-SNAPCHAT_UNIQUE_SESSIONS", "-SNAPCHAT_VIEW_TIME_SECONDS", "-SNAPCHAT_VIEWERS", "-SNAPCHAT_VIEWS" ], "type": "string" } }, { "description": "Number of results to return in a single response.", "in": "query", "name": "limit", "required": false, "schema": { "default": 100, "maximum": 1000, "minimum": 1, "type": "integer" } }, { "description": "The offset of the first result to be returned.", "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "minimum": 0, "type": "integer" } }, { "description": "A formatted datetime string in UTC.", "in": "query", "name": "start_date", "required": false, "schema": { "default": null, "example": "2019-12-01", "nullable": true, "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(Z|((\\+|-)\\d{2}:\\d{2})))?$", "type": "string" } }, { "description": "A formatted datetime string in UTC.", "in": "query", "name": "end_date", "required": false, "schema": { "default": null, "example": "2019-12-12", "nullable": true, "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(Z|((\\+|-)\\d{2}:\\d{2})))?$", "type": "string" } }, { "description": "Only return media that have products.", "in": "query", "name": "with_products_only", "required": false, "schema": { "default": false, "type": "boolean" } }, { "description": "Comma-separated list of IDs to return.", "explode": false, "in": "query", "name": "include_product_overrides", "required": false, "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicGalleryMediaList" } } }, "description": "OK" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "tags": [ "PublicGallery" ], "x-public": true, "summary": "Retrieve gallery media", "description": "Returns media items from a gallery. This is a public endpoint \u2014 no authorization required.", "security": [] }, "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "minimum": 0, "type": "integer" } }, { "description": "The ID of the gallery.", "in": "path", "name": "gallery_id", "required": true, "schema": { "minimum": 0, "type": "integer" } } ] }, "/public/brands/{brand_id}/media/v2/{media_id}": { "get": { "parameters": [ { "description": "Comma-separated list of optional fields to exclude.", "explode": false, "in": "query", "name": "exclude", "required": false, "schema": { "example": [ "source_data" ], "items": { "enum": [ "predictions", "source_data", "comment_sentiment", "visual_features" ], "type": "string" }, "type": "array" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicMediaV2" } } }, "description": "OK" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "tags": [ "PublicMedia" ], "x-public": true }, "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "format": "int32", "type": "integer" } }, { "description": "The ID of the media object.", "in": "path", "name": "media_id", "required": true, "schema": { "format": "int32", "type": "integer" } } ] }, "/public/brands/{brand_id}/products/media": { "get": { "parameters": [ { "description": "Source ID of the product (SKU or brand's product ID).", "in": "query", "name": "product_source_id", "required": false, "schema": { "type": "string" } }, { "description": "Request true if there are multiple product rows with the same source_id, otherwise only the first will be returned.", "in": "query", "name": "multiple_by_source_id", "required": false, "schema": { "default": false, "type": "boolean" } }, { "description": "Source ID of the catalog/collection the product belongs to.", "in": "query", "name": "product_source_group_id", "required": false, "schema": { "type": "string" } }, { "description": "Request true to order results by the most recent source media created date.", "in": "query", "name": "sort_by_source_created", "required": false, "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/PublicBrandMediaWithProducts" }, "type": "array" } } }, "description": "OK" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "tags": [ "PublicProduct" ], "x-public": true, "security": [], "summary": "Retrieve product media", "description": "Returns media associated with products for a brand. No authentication required." }, "parameters": [ { "description": "The Dash Social assigned ID of the brand.", "in": "path", "name": "brand_id", "required": true, "schema": { "format": "int32", "type": "integer" } } ] }, "/reports/likeshop/benchmark": { "post": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LikeShopBenchmarkReportRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LikeShopBenchmarkReportResponse" } } }, "description": "OK" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Returns a CSV file of LikeShop benchmarks for the requested Instagram accounts", "tags": [ "Reports" ] } }, "/url_metadata": { "get": { "description": "This will scrape a given URL for Open Graph metadata. If Open Graph properties aren't found,\nit will do its best to fall back to something on the page that closely represents that data.", "parameters": [ { "description": "The URL to fetch metadata for.", "in": "query", "name": "url", "required": true, "schema": { "format": "url", "type": "string" } }, { "description": "If true, retry fetching metadata until title and image are returned (or retries are exhausted). Only works for approved domains.", "in": "query", "name": "retry_fetch", "required": false, "schema": { "default": false, "type": "boolean", "writeOnly": true } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UrlMetadata" } } }, "description": "OK" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Get Open Graph metadata for a URL.", "tags": [ "URL Metadata" ] } }, "/url_metadata/encoding": { "post": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EncodingRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EncodingResponse" } } }, "description": "OK" }, "422": { "$ref": "#/components/responses/UNPROCESSABLE_ENTITY" }, "default": { "$ref": "#/components/responses/DEFAULT_ERROR" } }, "summary": "Attempt to detect the encoding of a path. Will accept HTTPS and SFTP URLs", "tags": [ "URL Metadata" ] } } }, "servers": [ { "url": "https://library-backend.dashsocial.com" } ], "tags": [ { "description": "Endpoints responsible for administrative actions.", "name": "Admin" }, { "description": "Endpoint(s) for working with affiliate links in campaigns", "name": "AffiliateLinks" }, { "description": "Endpoints responsible for managing AI alternative ads.", "name": "AiAlternativeAds" }, { "description": "Endpoints responsible for managing AI alternative media.", "name": "AiAlternativeMedia" }, { "description": "Endpoints responsible for fetching AI alternative media for a brand.", "name": "BrandAiAlternativeMedia" }, { "description": "Endpoints responsible for creating, reading, and updating campaigns.", "name": "Campaign" }, { "description": "Endpoints responsible for bulk campaigns actions for many brands.", "name": "CampaignBulk" }, { "description": "Endpoints for campaign benchmarks.", "name": "CampaignBenchmarks" }, { "description": "CRUD endpoint for comparing campaigns", "name": "Campaign Comparison" }, { "description": "Endpoints responsible for searching for competitors", "name": "Competitors" }, { "description": "Endpoints relating to content automations", "name": "Content Automations" }, { "description": "Endpoints relating to content automations across organizations", "name": "Content Automations Cross Organization" }, { "description": "Endpoints for content rights management.", "name": "ContentRights" }, { "description": "Endpoints relating to brand media content tags.", "name": "BrandMediaContentTags" }, { "description": "Endpoints relating to content tags.", "name": "ContentTags" }, { "description": "Endpoints relating to custom metrics", "name": "Custom Metrics" }, { "description": "Endpoints relating to segment clusters tags", "name": "SegmentClusterTags" }, { "description": "Endpoints relating to segment clusters tag associations", "name": "SegmentClusterTagAssociations" }, { "description": "Retrieve competitors for a channel", "name": "CompetitorsSearch" }, { "description": "Endpoints responsible for creating, reading, and updating galleries.", "name": "Gallery" }, { "description": "Public endpoints responsible for reading galleries", "name": "PublicGallery" }, { "description": "Endpoints responsible for gallery tags operations.", "name": "GalleryTags" }, { "description": "Endpoints relating to content automations.", "name": "ContentContentAutomations" }, { "description": "Endpoints responsible for starting, continuing, and reading gallery transfers", "name": "GalleryTransfer" }, { "description": "Endpoints to fetch Google Analytics data for brands", "name": "GoogleAnalytics" }, { "description": "Endpoints responsible for processing media (mostly superseded by v2).", "name": "MediaV1" }, { "description": "Endpoints responsible for searching for media", "name": "MediaSearch" }, { "description": "Endpoints responsible for creating, reading, updating a single piece of media.", "name": "Single Media" }, { "description": "Endpoints responsible for creating, reading, and updating media.", "name": "Media" }, { "description": "Endpoints responsible for query aggregated media timeseries metrics.", "name": "MediaTimeseriesMetrics" }, { "description": "Public endpoints responsible for reading media", "name": "PublicMedia" }, { "description": "Endpoints responsible for creating, reading, and updating products.", "name": "Product" }, { "description": "Public endpoints responsible for reading products.", "name": "PublicProduct" }, { "description": "Endpoints responsible for creating, reading, and updating Product Catalogs.", "name": "Product Catalog" }, { "description": "Endpoints responsible for creating, reading, and updating Product Feeds.", "name": "Product Feed" }, { "description": "Report generation", "name": "Reports" }, { "description": "Endpoints responsible for fetching Open Graph metadata.", "name": "URL Metadata" }, { "description": "UTM Settings, preset values and encoding/decoding of scheduler posts", "name": "UTMSettings" }, { "description": "Endpoints for video generation usage.", "name": "VideoGeneration" } ], "security": [ { "BearerAuth": [] } ] }