Skip to main content
GET
Retrieve galleries

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

brand_id
integer
required

The Dash Social assigned ID of the brand.

Required range: x >= 0

Query Parameters

ids
integer[]

Comma-separated list of IDs to return.

limit
integer
default:100

Number of results to return in a single response.

Required range: 0 <= x <= 1000
offset
integer
default:0

The offset of the first result to be returned.

Required range: x >= 0
brand_id
integer | null

The Dash Social assigned ID of the brand.

type
enum<string> | null

Limits the galleries returned to this type.

Available options:
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
types
enum<string>[]

Limits the galleries returned to types in this list

Available options:
INSTAGRAM,
INSTAGRAM_LIKESHOP,
PINTEREST,
LIBRARY,
INSTAGRAM_STORY,
INSTAGRAM_STORY_NARRATIVE,
TIKTOK,
TIKTOK_LIKESHOP,
FACEBOOK,
TWITTER,
YOUTUBE,
LINKEDIN,
THREADS,
SNAPCHAT
min_size
integer | null

Limits the galleries returned to be not have smaller size

search
string | null

Search for galleries based on name using wildcards

sort
enum<string>

Media filter order. "-" means in a desc order.

Available options:
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
tags
integer[]

List of tags used to limit galleries returned.

tags_filter_type
enum<string>
default:OR

Determines if all or any of the tags are used when searching for galleries.

Available options:
and,
AND,
or,
OR
summary
boolean

Returns a list of summary gallery objects.

live
integer | null

Filter live galleries.

spirit_gallery_enabled
integer | null

Filter Shoppable galleries.

start_date
string | null

A formatted datetime string in UTC.

Pattern: ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(Z|((\+|-)\d{2}:\d{2})))?$
Example:

"2019-12-01"

end_date
string | null

A formatted datetime string in UTC.

Pattern: ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(Z|((\+|-)\d{2}:\d{2})))?$
Example:

"2019-12-12"

Response

OK

data
object[]
paging
object