List locations within a project

post

https://api.convert.com/api/v2/accounts/{account_id}/projects/{project_id}/locations

Retrieves a list of all locations defined for a specific project. Locations define where on a website an experience will run, based on URL patterns, page tags, or JavaScript conditions. Supports filtering by status, name, and pagination. The Knowledge Base article "Locations" explains: "Locations conditions include the pages on which the experiment will run."

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

account_id

integer

required

ID of the account that owns the retrieved/saved data

project_id

integer

required

ID of the project to which save/retrieved data is connected

Body Params

onlyCount

boolean

If set to true in a list request, the response will only contain the total count of matching items (extra.pagination.items_count) and will not include the actual item data. Useful for quickly getting totals without fetching full datasets.

results_per_page

integer | null

0 to 50

Defaults to 30

Specifies the maximum number of items to return in a single page of results. Used for pagination. Default is 30, maximum is 50.

sort_direction

string | null

enum

Defaults to desc

The direction for sorting the list results, based on the sort_by field.

asc: Ascending order (e.g., A-Z, 1-10, oldest to newest).
desc: Descending order (e.g., Z-A, 10-1, newest to oldest). Defaults to desc (newest/highest first) if not specified.

Allowed:

status

array of objects | null

List of Location statuses to be returned

status

is_default

boolean | null

It indicates wherever retrieved locations are default or not

If not provided, it will return all locations. If not provided, it will return all locations

string | null

a search string that would be used to search against Location's name or description

sort_by

string | null

enum

Defaults to id

A value to sort Location by specific field

Defaults to id if not provided

Allowed:

usage

string | null

enum

It indicates wherever retrieved locations are used or not inside experiences

Allowed:

page

integer

≥ 1

The page number for paginated results. For example, if results_per_page is 30, page: 2 will retrieve items 31-60. Defaults to 1 if not specified.

include

array of objects

Specifies the list of fields to be included in the response, which otherwise would not be sent.

include

only

array of integers | null

Only retrieve location with the given ids.

only

except

array of integers

length ≤ 100

Except locations with the given ids.

except

Responses

200A list of locations defined within a project. Each location entry includes its ID, name, status, and potentially usage statistics if requested. Locations define where experiences run.

defaultIndicates an error occurred while processing the request. The code provides an HTTP status code, message offers a human-readable explanation or an array of validation errors, and fields (if present) specifies which input fields were problematic.