Examples

This article provides examples of how to query and filter results using the Analytics API.

This section of the documentation provides examples that show you how to query the Analytics API.

Filters

The following filters can be applied to metrics and reports:

start: “YYYY-MM-DD”
end: “YYYY-MM-DD”

Reports have additional page and per_page filters:

page: 1
per_page: 20 (maximum 100)

Social metrics have the additional filter:

platform: [instagram, tiktok, youtube]

The next section contains example queries with these filters in use.

Examples

Metrics (social, site, sales):

{

  metrics(start_date: "2023-01-01", end_date: "2025-01-01") {

    social {

      views_count

      posts_count

      earned_media_value

      engagement_rate_organic

      engagements_count

      link_clicks_count

    }

    site {

      views_count

      video_views_count

      video_visits_count

      photo_views_count

      photo_visits_count

      storefront_views_count

      storefront_visits_count

    }

    sales {

      video_conversions_count

      video_sales_amount

      video_conversion_rate

      revenue_per_video_view

      photo_conversions_count

      photo_sales_amount

      photo_conversion_rate

      revenue_per_photo_view

      storefront_sales_amount

      storefront_conversion_rate

      storefront_conversions_count

      link_click_conversions_count

      conversions_count

      average_order_value

      sales_amount

      sales_count

    }

  }

}

Column detail:

Field	Type	Maximum length	Nullable
social.earned_media_value	BigDecimal	10	Yes
social.posts_count	Long	19	Yes
social.engagement_rate_organic	Float	19	Yes
social.views_count	Long	19	Yes
social.link_clicks_count	Long	19	Yes
social.engagements_count	Long	19	Yes
site.video_visits_count	Long	19	Yes
site.photo_visits_count	Long	19	Yes
site.storefront_visits_count	Long	19	Yes
site.video_views_count	Long	19	Yes
site.photo_views_count	Long	19	Yes
site.storefront_views_count	Long	19	Yes
site.views_count	Long	19	Yes
sales.photo_conversions_count	Long	19	Yes
sales.video_conversions_count	Long	19	Yes
sales.storefront_sales_amount	BigDecimal	10	Yes
sales.storefront_conversion_rate	Float	19	Yes
sales.conversions_count	Long	19	Yes
sales.average_order_value	BigDecimal	10	Yes
sales.revenue_per_photo_view	BigDecimal	10	Yes
sales.video_sales_amount	BigDecimal	10	Yes
sales.video_conversion_rate	Float	19	Yes
sales.photo_conversion_rate	Float	19	Yes
sales.photo_sales_amount	BigDecimal	10	Yes
sales.storefront_conversions_count	Long	19	Yes
sales.revenue_per_view_view	BigDecimal	10	Yes
sales.sales_amount	BigDecimal	10	Yes

Social report

{

  social_report(start: "2023-01-01", end: "2025-06-12", page: 1, per_page: 20) {

    total,

    items {

      social_platform

   social_post_id

   post_type

   post_date

   social_post_text

   social_post_link

   creator_first_name

   creator_last_name

   creator_id

   employee_id

store {

    id,

               name,

    store_number

}

   region

   tier

   likes

   shares

   views

   comments

   max_reach

   max_views

   saves

   impressions

   engagements

   engagement_rate

   boosted

   emv

    }

  }

}

Column detail:

Field	Type	Maximum length	Nullable
platform	String	255	No
post_id	String	255	No
post_type	String	255	No
post_date	DateTime	36	No
url	String	2048	No
boosted	Boolean	5	No
creator_name	String	255	No
creator_id	Long	19	No
employee_id	String	255	Yes
tier	String	255	Yes
store.id	String	255	Yes
store.name	String	255	Yes
store.store_number	String	255	Yes
region	String	255	Yes
likes_count	Long	19	No
shares_count	Long	19	No
views_count	Long	19	No
comments_count	Long	19	No
saves_count	Long	19	No
engagements_count	Long	19	No
engagement_rate	Float	19	No
emv	BigDecimal	10	No

Team creator report:

{

  team_report(

start_date: "2025-01-01"

end_date: "2025-01-31"

page: 1

per_page: 20

  ) {

total

items {

   creator_name

   creator_id

   site_views

   social_engagements_count

   social_followers_count

   emv

   sales_amount

   sales_count

   average_order_value

   conversion_rate

   employee_id

   tier

store {

    id,

          name,

          store_number

}

   region

   content_created_count

   latest_content_created

   social_posts_published_count

   latest_social_post_published

}

  }

}

Column detail:

Column details:

Field	Type	Maximum length	Nullable
creator_name	String	255	No
creator_id	Long	19	No
site_views	Long	19	No
social_engagements_count	Long	19	No
social_followers_count	Long	19	No
emv	BigDecimal	10	No
sales_amount	BigDecimal	10	No
sales_count	Long	19	No
average_order_value	BigDecimal	10	No
conversion_rate	Float	19	No
employee_id	String	255	Yes
tier	String	255	Yes
store.id	String	255	Yes
store.name	String	255	Yes
store.store_number	String	255	Yes
region	String	255	Yes
content_created_count	Int	10	No
latest_content_created	DateTime	36	Yes
social_posts_published_count	Int	10	No
latest_social_post_published	DateTime	36	Yes

Site report:

{

  site_report(

start_date: "2025-01-01"

end_date: "2025-01-31"

page: 1

per_page: 20

  ) {

total

items {

   asset_id

   title

   creator_name

   creator_id

   views_count

   clicks

   sales_amount

   sales_orders

   average_order_value

   employee_id

   tier

store {

    id,

          name,

          store_number

}

   region

   view_through_rate

   dropoff

   campaign_id

   campaign_title

}

  }

}

Column detail:

Field	Type	Maximum length	Nullable
asset_id	Long	19	No
title	String	255	Yes
creator_name	String	255	No
creator_id	Long	19	Yes
views_count	Long	19	No
clicks	Long	19	No
sales_amount	Long	19	No
sales_orders	Int	10	No
average_order_value	BigDecimal	10	No
employee_id	String	255	Yes
tier	String	255	Yes
store.id	String	255	Yes
store.name	String	255	Yes
store.store_number	String	255	Yes
region	String	255	Yes
view_through_rate	Float	19	Yes
dropoff	Int	10	Yes
campaign_id	Long	19	Yes
campaign_title	String	255	Yes

Transaction report:

{

  transaction_report(

start_date: "2025-01-01"

end_date: "2025-01-31"

page: 1

per_page: 20

  ) {

total

items {

   transaction_id

   transaction_date

   asset_id

   asset_title

   asset_type

   creator_name

   creator_id

   sale_amount

   employee_id

   tier

store {

    id,

          name,

          store_number

}

   region

campaign_id

   campaign_title

}

  }

}

Column detail:

Field	Type	Maximum length	Nullable
transaction_id	String	255	No
transaction_date	DateTime	36	No
asset_id	Long	19	Yes
asset_title	String	255	Yes
asset_type	String	10	Yes
creator_name	String	255	No
creator_id	Long	19	Yes
sale_amount	BigDecimal	10	No
tier	String	255	Yes
store.id	String	255	Yes
store.name	String	255	Yes
store.store_number	String	255	Yes
region	String	255	Yes
campaign_id	Long	19	Yes
campaign_title	String	255	Yes

Transaction detail report:

{

  transaction_details_report(

start_date: "2025-01-01"

end_date: "2025-01-31"

page: 1

per_page: 20

  ) {

total

items {

   transaction_id

   transaction_date

   transaction_item_date

   status

   product_id

   sku

   product_title

   asset_id

   asset_title

   asset_type

   asset_type

   quantity

   item_price

   amount

   creator_name

   creator_id

   employee_id

   tier

store {

    id,

          name,

          store_number

}

   region

  }

}

Column detail:

Field	Type	Maximum length	Nullable
transaction_id	String	255	No
transaction_date	DateTime	36	No
transaction_item_date	DateTime	36	No
status	String	255	No
product_id	Long	19	Yes
sku	String	255	No
product_title	String	255	No
asset_id	Long	19	No
asset_title	String	255	No
asset_type	String	10	No
quantity	Int	10	No
item_price	BigDecimal	10	No
amount	BigDecimal	10	No
creator_name	String	255	No
creator_id	Long	19	Yes
employee_id	String	255	Yes
tier	String	255	Yes
store.id	String	255	Yes
store.name	String	255	Yes
store.store_number	String	255	Yes
region	String	255	Yes