Rally UXR Developer Docs

Panels
- Get paginated list of panelspost
People
Person Properties
Populations
- Paginated list of population in your workspaceget
Segments
- Paginated list of segments in your workspacepost
Studies
Participants
Incentives
Imports
- Gets an import by idget
Users
- Gets a paginated list of all usersget
Teams
- Paginated list of teams in your workspaceget
Backfills
- Import activitiespost
Person
person.opted_out
- postpost
person_import.api.finished
- postpost
participant.status_changed
- postpost

Rally UXR Developer Docs

Panels
- Get paginated list of panelspost
People
Person Properties
Populations
- Paginated list of population in your workspaceget
Segments
- Paginated list of segments in your workspacepost
Studies
Participants
Incentives
Imports
- Gets an import by idget
Users
- Gets a paginated list of all usersget
Teams
- Paginated list of teams in your workspaceget
Backfills
- Import activitiespost
Person
person.opted_out
- postpost
person_import.api.finished
- postpost
participant.status_changed
- postpost

Get paginated list of studies in your workspace.

post https://api.rallyuxr.com/api/public/v1/studies/search

Filtering currently not supported

URL Expired

The URL for this request expired after 30 days.

Body Params

filter

object

Filter option to search for studies

pageInfo

object

Pagination arguments. Use startCursor from the result of the endCursor of the response to get the next page. Pagination in reverse is not currently supported

Responses

Response body

object

results

array of objects

required

results*

object

studyId

string

required

studyType

string

required

The type of study

SURVEY INTERVIEWS UNMODERATED_TEST GROUP_INTERVIEW

recruitmentStrategy

string

required

The recruitment strategy for the study

IN_RALLY EXTERNAL

status

string

required

The status of the study

DRAFT ACTIVE PAUSED CLOSED

studyPlan

object

required

Study plan object

createdAt

date-time

required

total

number

required

The total number of items in your workspaces based on your search parameters

pageInfo

object

required

Information about the current page

hasNextPage

boolean

required

Whether there are additional pages of results

hasPreviousPage

boolean

required

Whether there is a prior page of results

startCursor

string

The start of the current page of results

endCursor

string

The end of the current page of results. Use to fetch the next page

Headers

object

X-RateLimit-Limit

int32

The maximum number of requests the client is allowed to make.

X-RateLimit-Remaining

int32

The number of requests remaining for the client in the current time window.

X-RateLimit-Reset

int32

The time at which the current time window ends (in Unix timestamp format).

Response body

object

errors

array of objects

required

errors*

object

message

string

required

path

array

required

path*

Response body

string

Headers

object

X-RateLimit-Limit

int32

The maximum number of requests the client is allowed to make.

X-RateLimit-Remaining

int32

The number of requests remaining for the client in the current time window.

X-RateLimit-Reset

int32

The time at which the current time window ends (in Unix timestamp format).

Response body

string

Headers

object

X-RateLimit-Limit

int32

The maximum number of requests the client is allowed to make.

X-RateLimit-Remaining

int32

The number of requests remaining for the client in the current time window.

X-RateLimit-Reset

int32

The time at which the current time window ends (in Unix timestamp format).

Response body

string

Headers

object

Retry-After

int32

The number of seconds until the client should retry the request.

X-RateLimit-Limit

int32

The maximum number of requests the client is allowed to make.

X-RateLimit-Remaining

int32

The number of requests remaining for the client in the current time window.

X-RateLimit-Reset

int32

The time at which the current time window ends (in Unix timestamp format).

Response body

string

Headers

object

X-RateLimit-Limit

int32

The maximum number of requests the client is allowed to make.

X-RateLimit-Remaining

int32

The number of requests remaining for the client in the current time window.

X-RateLimit-Reset

int32

The time at which the current time window ends (in Unix timestamp format).

Updated 7 months ago

Paginated list of participants in a study

Import participants to a study

Did this page help you?

Language

Credentials

Bearer


xxxxxxxxxx
14
1
curl --request POST \
2
     --url https://api.rallyuxr.com/api/public/v1/studies/search \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "filter": {
8
    "operator": "AND"
9
  },
10
  "pageInfo": {
11
    "size": 25
12
  }
13
}
14
'

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

application/json

text/plain

Updated 7 months ago

Paginated list of participants in a study

Import participants to a study

Did this page help you?

Rally UXR Developer Docs
Panels
Get paginated list of panelspost
People
Update a person's opted out statusput
Get a person's opted out status by ID or emailget
Delete a persondelete
Delete peoplepost
Import peoplepost
Search for peoplepost
Person Properties
Update a person property by IDput
Deletes a person property by IDdelete
Get a person property by IDget
Delete person properties in bulkpost
Get all person properties in your workspaceget
Create multiple new person propertiespost
Populations
Paginated list of population in your workspaceget
Segments
Paginated list of segments in your workspacepost
Studies
Get a paginated list of study templatesget
Update a study statuspost
Get a study by IDget
Update a studypatch
Update a studyput
Import participants to a studypost
Get paginated list of studies in your workspace.post
Paginated list of participants in a studypost
Create a new studypost
Participants
Incentives
Get a custom incentive by idget
Get paginated list of custom incentivesget
Get paginated list of incentivespost
Imports
Gets an import by idget
Users
Gets a paginated list of all usersget
Teams
Paginated list of teams in your workspaceget
Backfills
Import activitiespost
Person
Deletes people by emailpost
Updates a person's opted out statuspost
Returns a person in your workspaceget
person.opted_out
post
person_import.api.finished
post
participant.status_changed
post

Rally UXR Developer Docs
Panels
Get paginated list of panelspost
People
Update a person's opted out statusput
Get a person's opted out status by ID or emailget
Delete a persondelete
Delete peoplepost
Import peoplepost
Search for peoplepost
Person Properties
Update a person property by IDput
Deletes a person property by IDdelete
Get a person property by IDget
Delete person properties in bulkpost
Get all person properties in your workspaceget
Create multiple new person propertiespost
Populations
Paginated list of population in your workspaceget
Segments
Paginated list of segments in your workspacepost
Studies
Get a paginated list of study templatesget
Update a study statuspost
Get a study by IDget
Update a studypatch
Update a studyput
Import participants to a studypost
Get paginated list of studies in your workspace.post
Paginated list of participants in a studypost
Create a new studypost
Participants
Incentives
Get a custom incentive by idget
Get paginated list of custom incentivesget
Get paginated list of incentivespost
Imports
Gets an import by idget
Users
Gets a paginated list of all usersget
Teams
Paginated list of teams in your workspaceget
Backfills
Import activitiespost
Person
Deletes people by emailpost
Updates a person's opted out statuspost
Returns a person in your workspaceget
person.opted_out
post
person_import.api.finished
post
participant.status_changed
post

200The studies metadata

400Bad Request

401Unauthorized

403Forbidden

429Too Many Requests

500Internal Server Error