List hypotheses within a project

Retrieves a list of all hypotheses defined for a specific project. A hypothesis is an assumption about a proposed change and its expected impact, forming the basis for an experiment. Supports filtering by status, score, name, and pagination. The Knowledge Base article "Hypotheses (Compass)" explains: "A hypothesis is an assumption that a proposed change in your website would lead to visitors taking the action that you want them to."

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

ID of the account that owns the retrieved/saved data

integer
required

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

Body Params
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.

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.

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:
string | null
enum
Defaults to id

A value to sort hypotheses by specific field(s)

Defaults to id if not provided

Allowed:
integer | null
enum
Defaults to 5

The maximum score for hypotheses which you would like to retrieve

Allowed:
integer | null
enum
Defaults to 0

The minimum score for hypotheses which you would like to retrieve

Allowed:
string | null

A search string that would be used to search against hypotheses's name or description

status
array of objects | null

The status of the hypotheses you'd like to be returned; one of the below can be provided

status
experiences
array of integers | null

The list of experience ID's used to filter the list of returned hypotheses

experiences
tags
array of integers | null

The list of tag ID's used to filter the list of returned hypotheses

tags
only
array of integers | null

Only retrieve hypotheses with the given ids.

only
except
array of integers
length ≤ 100

Except hypotheses with the given ids.

except
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.

expand
array of objects

Specifies the list of fields which would be expanded in the response. Otherwise, only their id would be returned. Read more in the section related to Expanding Fields

expand
Responses

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json