Docs

List guides

Returns a list of eligible in-app guides for a specific user and channel.

List guides

Returns a list of eligible in-app guides for a specific user and channel.

Endpoint

GET/v1/users/{user_id}/guides/{channel_id}

Rate limit

Tier 2

Path parameters

user_id

string

The unique identifier of the user.

channel_id

string(uuid)

The unique identifier for the channel.

Query parameters

tenant

string

The tenant ID to use for targeting and rendering guides.

data

string

The data (JSON encoded object) to use for targeting and rendering guides.

type

string

The type of guides to filter by.

Returns

GuidesResponse

A response for a list of guides.

entries

object[]

A list of guides.

__typename

string

The typename of the schema.

activation_url_patterns

object[]

A list of URL Patterns to evaluate user's current location to activate the guide, if matched

directive

string

The directive for the URL pattern ('allow' or 'block')

pathname

string

The pathname pattern to match (supports wildcards like /*)

activation_url_rules

object[]

A list of URL rules to evaluate user's current location to activate the guide, if matched

argument

string

The value to compare against

directive

string

The directive for the URL pattern ('allow' or 'block')

operator

string

The comparison operator ('contains' or 'equal_to')

variable

string

The variable to evaluate ('pathname')

active

boolean

Whether the guide is active.

bypass_global_group_limit

boolean

channel_id

string(uuid)

The unique identifier for the guide.

inserted_at

string(date-time)

key

string

The key of the guide.

semver

string

steps

object[]

content

object(any)

message

object

archived_at

string(date-time)

string

interacted_at

string(date-time)

link_clicked_at

string(date-time)

read_at

string(date-time)

seen_at

string(date-time)

ref

string

schema_key

string

schema_semver

string

schema_variant_key

string

type

string

The type of the guide.

updated_at

string(date-time)

guide_group_display_logs

object(any)

A map of guide group keys to their last display timestamps.

guide_groups

object[]

A list of guide groups with their display sequences and intervals.

__typename

string

display_interval

integer

display_sequence

string[]

inserted_at

string(date-time)

key

string

updated_at

string(date-time)

ineligible_guides

object[]

Markers for guides the user is not eligible to see.

key

string

Required

The guide's key identifier

message

string

Required

Human-readable explanation of ineligibility

reason

enum(string)

Required

Reason code for ineligibility

guide_not_activemarked_as_archivedtarget_conditions_not_metnot_in_target_audience