Sign in
Analytics

CRM v2 filter vocabulary

The values you can actually filter the CRM v2 pipeline by for this shop — the products, sourcing automations, CRM tags and status tabs that exist in its data, plus the bounds of each metric range. Call this once to build a filter UI or to discover valid product_ids / automation_ids / tags before querying /funnel/v2/requests.

Single-shop, CRM v2 shops only.

get/funnel/v2/filter-config

Query parameters

pageinteger

Page number, 1-based.

Page number, 1-based.

page_sizeinteger

Rows per page (max 100).

Rows per page (max 100).

statusstring nullable

Pipeline tab to filter to. One of: toReview, readyToShip, shipped, pendingContent, completed, cancelled.

Pipeline tab to filter to. One of: toReview, readyToShip, shipped, pendingContent, completed, cancelled.

product_idsstring nullable

Comma-separated product IDs.

Comma-separated product IDs.

profile_idsstring nullable

Comma-separated creator profile IDs.

Comma-separated creator profile IDs.

automation_idsstring nullable

Comma-separated automation IDs that sourced the request.

Comma-separated automation IDs that sourced the request.

tagsstring nullable

Comma-separated CRM tags.

Comma-separated CRM tags.

created_fromstring nullable

Earliest request date, YYYY-MM-DD (inclusive).

Earliest request date, YYYY-MM-DD (inclusive).

created_tostring nullable

Latest request date, YYYY-MM-DD (inclusive).

Latest request date, YYYY-MM-DD (inclusive).

searchstring nullable

Free-text search over creator handle / name.

Free-text search over creator handle / name.

sort_bystring

Sort field.

Sort field.

sort_directionstring

'asc' or 'desc'.

'asc' or 'desc'.

exclude_rejectedboolean

Drop rejected requests.

Drop rejected requests.

show_archivedboolean

Return archived requests instead.

Return archived requests instead.

show_expiringboolean

Only requests expiring soon.

Only requests expiring soon.

min_post_ratenumber nullable
max_post_ratenumber nullable
min_pps_scorenumber nullable
max_pps_scorenumber nullable
min_avg_viewsnumber nullable
max_avg_viewsnumber nullable
min_engagement_ratenumber nullable
max_engagement_ratenumber nullable
min_live_gmvnumber nullable
max_live_gmvnumber nullable
min_shop_gmvnumber nullable
max_shop_gmvnumber nullable
min_creator_gmvnumber nullable
max_creator_gmvnumber nullable
min_avg_gmv_videonumber nullable
max_avg_gmv_videonumber nullable
min_gmv_samplenumber nullable
max_gmv_samplenumber nullable
min_videos_per_samplenumber nullable
max_videos_per_samplenumber nullable

Response

Successful Response

{"stackTrail":"paths:/funnel/v2/filter-config:get:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}

Changes

No recorded changes to this endpoint across all 1 revision of this API.