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

Search for people

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

Search for people in your workspace. You can filter by studies, segments, and panels. Or just retrieve additional metadata about a list of person ids

URL Expired

The URL for this request expired after 30 days.

Body Params

attachProperties

array of strings

length ≤ 10

List of the propertyIds of custom properties to attach to the response for each person

attachProperties

peopleIds

array of strings

length ≤ 100

List of person IDs to filter people by

peopleIds

filter

object

Filters to apply to the search. This and the deprecated top level filters cannot be used at the same time

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

Show Deprecated

Responses

Response body

object

results

array of objects

required

results*

object

personId

string

required

The ID of the person

string | null

required

The email of the person

properties

array of objects

required

properties*

object

propertyId

string

required

The ID of the property

propertyType

string

required

The type of the property

STRING NUMBER DATETIME BOOLEAN SINGLE_SELECT MULTI_SELECT LOCATION

value

required

The value of a person's property. Will be coerced to the value type of the property. Dates must be in YYYY-MM-DD

populationIds

array of strings

required

List of populationIds for populations the person is in

populationIds*

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

errors

array of objects

required

errors*

object

errorCode

string

required

UNAUTHORIZED

propertyId

string

required

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 5 months ago

Get paginated list of panels

Import people

Did this page help you?

Language

Credentials

Bearer


xxxxxxxxxx
14
1
curl --request POST \
2
     --url https://api.rallyuxr.com/api/public/v1/people/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 5 months ago

Get paginated list of panels

Import people

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

200Successfully retrieved people

400Bad Request

401Unauthorized

403Forbidden

429Too Many Requests

500Internal Server Error