Skip to main content
GET
/
brands
/
{brand_id}
/
galleries
Retrieve galleries
curl --request GET \
  --url https://library-backend.dashsocial.com/brands/{brand_id}/galleries \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "brand_id": 123,
      "name": "<string>",
      "additional_stats": {},
      "created_at": "2023-11-07T05:31:56Z",
      "custom_content": {
        "banner": {
          "brand_media_type": "<string>",
          "can_publish_within": {
            "end": "<string>",
            "start": "<string>"
          },
          "clicks": 123,
          "created_at": "2023-11-07T05:31:56Z",
          "id": 123,
          "media": {
            "source_id": "<string>",
            "created_at": "2023-11-07T05:31:56Z",
            "duration": "<unknown>",
            "frame_rate": "<unknown>",
            "id": 123,
            "image_sizes": "<unknown>",
            "media_group": 123,
            "notes": "<string>",
            "original_height": 123,
            "original_width": 123,
            "predictions": "<unknown>",
            "source_created_at": "2026-04-10T14:57:59.977494",
            "source_data": "<unknown>",
            "tags": [
              {
                "brand_id": 123,
                "name": "<string>",
                "created_at": "2023-11-07T05:31:56Z",
                "id": 123,
                "updated_at": "2023-11-07T05:31:56Z"
              }
            ],
            "type": "<string>",
            "updated_at": "2023-11-07T05:31:56Z",
            "urls": "<unknown>",
            "video_sizes": "<unknown>"
          },
          "order": 123,
          "products": [
            {
              "archived": true,
              "clicks": 123,
              "created_at": "2023-11-07T05:31:56Z",
              "description": "<string>",
              "id": 123,
              "image_url": "<string>",
              "product_groups": [
                {
                  "country_code": "<string>",
                  "created_at": "2023-11-07T05:31:56Z",
                  "description": "<string>",
                  "image_url": "<string>",
                  "source_id": "<string>",
                  "title": "<string>",
                  "url": "<string>"
                }
              ],
              "product_overrides": [
                {
                  "brand_id": 123,
                  "override": "<string>",
                  "source_id": "<string>",
                  "availability": "<string>",
                  "created_at": "2023-11-07T05:31:56Z",
                  "currency_code": "<string>",
                  "description": "<string>",
                  "id": 123,
                  "image_url": "<string>",
                  "last_updated_by_product_feed_at": "2023-11-07T05:31:56Z",
                  "original_url": "<string>",
                  "price": "<string>",
                  "title": "<string>",
                  "updated_at": "2023-11-07T05:31:56Z",
                  "url": "<string>"
                }
              ],
              "source_id": "<string>",
              "title": "<string>",
              "updated_at": "2023-11-07T05:31:56Z",
              "url": "<string>",
              "x": 123,
              "y": 123
            }
          ],
          "updated_at": "2023-11-07T05:31:56Z"
        },
        "pinned": [
          {
            "brand_media_type": "<string>",
            "can_publish_within": {
              "end": "<string>",
              "start": "<string>"
            },
            "clicks": 123,
            "created_at": "2023-11-07T05:31:56Z",
            "id": 123,
            "media": {
              "source_id": "<string>",
              "created_at": "2023-11-07T05:31:56Z",
              "duration": "<unknown>",
              "frame_rate": "<unknown>",
              "id": 123,
              "image_sizes": "<unknown>",
              "media_group": 123,
              "notes": "<string>",
              "original_height": 123,
              "original_width": 123,
              "predictions": "<unknown>",
              "source_created_at": "2026-04-10T14:57:59.977494",
              "source_data": "<unknown>",
              "tags": [
                {
                  "brand_id": 123,
                  "name": "<string>",
                  "created_at": "2023-11-07T05:31:56Z",
                  "id": 123,
                  "updated_at": "2023-11-07T05:31:56Z"
                }
              ],
              "type": "<string>",
              "updated_at": "2023-11-07T05:31:56Z",
              "urls": "<unknown>",
              "video_sizes": "<unknown>"
            },
            "order": 123,
            "products": [
              {
                "archived": true,
                "clicks": 123,
                "created_at": "2023-11-07T05:31:56Z",
                "description": "<string>",
                "id": 123,
                "image_url": "<string>",
                "product_groups": [
                  {
                    "country_code": "<string>",
                    "created_at": "2023-11-07T05:31:56Z",
                    "description": "<string>",
                    "image_url": "<string>",
                    "source_id": "<string>",
                    "title": "<string>",
                    "url": "<string>"
                  }
                ],
                "product_overrides": [
                  {
                    "brand_id": 123,
                    "override": "<string>",
                    "source_id": "<string>",
                    "availability": "<string>",
                    "created_at": "2023-11-07T05:31:56Z",
                    "currency_code": "<string>",
                    "description": "<string>",
                    "id": 123,
                    "image_url": "<string>",
                    "last_updated_by_product_feed_at": "2023-11-07T05:31:56Z",
                    "original_url": "<string>",
                    "price": "<string>",
                    "title": "<string>",
                    "updated_at": "2023-11-07T05:31:56Z",
                    "url": "<string>"
                  }
                ],
                "source_id": "<string>",
                "title": "<string>",
                "updated_at": "2023-11-07T05:31:56Z",
                "url": "<string>",
                "x": 123,
                "y": 123
              }
            ],
            "updated_at": "2023-11-07T05:31:56Z"
          }
        ]
      },
      "description": "<string>",
      "extra_csv_data": null,
      "fb_avg_effectiveness": 123,
      "fb_avg_engagement_rate": 123,
      "fb_avg_paid_and_organic_effectiveness_v2": 123,
      "fb_avg_paid_and_organic_engagement_rate_v2": 123,
      "fb_avg_paid_and_organic_reach_v2": 123,
      "fb_avg_reach": 123,
      "fb_total_engagements": 123,
      "fb_total_impressions": 123,
      "fb_total_paid_and_organic_engagements_v2": 123,
      "fb_total_paid_and_organic_views": 123,
      "gallery_distribution": {
        "competitive_post_count": 123,
        "owned_post_count": 123
      },
      "gallery_size": 123,
      "gallery_stats_updated": "2023-11-07T05:31:56Z",
      "gallery_type": "LIBRARY",
      "id": 123,
      "ig_story_avg_completion_rate": 123,
      "ig_story_avg_completion_rate_views": 123,
      "ig_story_avg_exit_rate": 123,
      "ig_story_avg_exit_rate_views": 123,
      "ig_story_avg_impressions": 123,
      "ig_story_avg_reach": 123,
      "ig_story_avg_views": 123,
      "ig_story_narrative_time_range": {
        "end": "2019-12-01T00:00:00+00:00",
        "start": "2019-12-01T00:00:00+00:00"
      },
      "ig_story_swipe_ups": 123,
      "ig_story_total_impressions": 123,
      "ig_story_total_reach": 123,
      "ig_story_total_replies": 123,
      "ig_story_total_views": 123,
      "instagram_avg_effectiveness": 123,
      "instagram_avg_effectiveness_engagements": 123,
      "instagram_avg_engagement": 123,
      "instagram_avg_reach": 123,
      "instagram_total_comments": 123,
      "instagram_total_likes": 123,
      "instagram_total_reach": 123,
      "label": "<string>",
      "latest_media": [
        {
          "image_url": "<string>"
        }
      ],
      "latest_media_published_at": "2023-11-07T05:31:56Z",
      "library_total_clicks": 123,
      "library_total_high_performing_photos": 123,
      "library_total_low_performing_photos": 123,
      "library_total_top_performing_photos": 123,
      "library_total_views": 123,
      "linkedin_avg_click_through_rate": 123,
      "linkedin_avg_engagement_rate": 123,
      "linkedin_avg_unique_impressions": 123,
      "linkedin_total_impressions": 123,
      "linkedin_total_likes": 123,
      "live": 123,
      "pinterest_avg_engagement_rate": 123,
      "pinterest_total_clicks": 123,
      "pinterest_total_closeups": 123,
      "pinterest_total_comments": 123,
      "pinterest_total_impressions": 123,
      "pinterest_total_saves": 123,
      "pinterest_total_video_views": 123,
      "pinterest_total_visits": 123,
      "settings": {},
      "snapchat_avg_engagement_rate": 123,
      "snapchat_avg_view_time": 123,
      "snapchat_total_engagements": 123,
      "snapchat_total_viewers": 123,
      "snapchat_total_views": 123,
      "spirit_gallery_enabled": 123,
      "tags": [
        {
          "color": "<string>",
          "name": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "id": 123,
          "updated_at": "2023-11-07T05:31:56Z"
        }
      ],
      "threads_avg_engagement_rate": 123,
      "threads_total_engagements": 123,
      "threads_total_likes": 123,
      "threads_total_replies": 123,
      "threads_total_views": 123,
      "tiktok_avg_engagement_rate": 123,
      "tiktok_avg_retention_rate": 123,
      "tiktok_avg_video_views": 123,
      "tiktok_total_reach": 123,
      "tiktok_total_video_views": 123,
      "twitter_avg_engagement_rate": 123,
      "twitter_impressions": 123,
      "twitter_likes": 123,
      "twitter_retweets": 123,
      "twitter_total_engagements": 123,
      "updated_at": "2023-11-07T05:31:56Z",
      "youtube_avg_view_duration": 123,
      "youtube_subscribers": 123,
      "youtube_total_engagements": 123,
      "youtube_total_video_views": 123,
      "youtube_total_watch_time": 123
    }
  ],
  "paging": {
    "count": 123,
    "next": "<string>",
    "previous": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://developer.dashsocial.com/llms.txt

Use this file to discover all available pages before exploring further.

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