List AudienceSegments

get

https://api.prtmb.com/api/v2/accounts/{account_id}/audiences/{audience_id}/segments

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

account_id

required

This parameter indicates which Account owns the collections and resources reference by the request.

As a convenience, the slug me may be used in place of the account_id in any URL where it is
required. When me is used it will be replaced with the account_id of the current User.

audience_id

required

This parameter indicates which Audience is referenced by the request.

As a convenience, the slug default may be used in place of the audience_id in any URL where it is
required. When default is used it will be replaced with the audience_id of the default audience
for the referenced Account.

Query Params

limit

integer

Defaults to 50

Limit the number of resources in the response. Set to 0 to disable the limit and receive all resources in the response. Combine with the offset parameter for pagination.

offset

integer

Defaults to 0

How many resources to offset from the beginning of the results (default: 0). Combined with the limit parameters this enables pagination through results. For example, to view the 2nd page of results, using the default limit of 50 the offset would be 50. For the 3rd page the offset would be 100 and so on.

name

string

Name of an AudienceSegment.

Query for AudienceSegments with a name field that contains the provided string. This parameter
is not case sensitive.

order_by

string

enum

Defaults to inserted_at_asc

Sort resources in the response.

Each of the options represents a query more than one sort_by parameter:

inserted_at_asc - is ORDER BY inserted_at ASC
inserted_at_desc - is ORDER BY inserted_at DESC
name_asc - is ORDER BY name ASC
name_desc - is ORDER BY name DESC

Allowed:

Response

Callback

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success