Rally Developer Docs home page

Support

Studies

Get paginated list of studies in your workspace.

Backfills

POST
Import activities

Person

GET
Returns a person in your workspace
POST
Updates a person's opted out status
POST
Deletes people by email

Imports

GET
Gets an import by id

Incentives

POST
Get paginated list of incentives

Panels

POST
Get paginated list of panels

People

POST
Search for people
POST
Import people
POST
Delete people
DEL
Delete a person
GET
Get a person's opted out status by ID or email
PUT
Update a person's opted out status

Populations

GET
Paginated list of population in your workspace

Person Properties

POST
Create multiple new person properties
GET
Get all person properties in your workspace
POST
Delete person properties in bulk
GET
Get a person property by ID
PUT
Update a person property by ID
DEL
Deletes a person property by ID

Segments

POST
Paginated list of segments in your workspace

Studies

POST
Create a new study
POST
Get paginated list of studies in your workspace.
GET
Get a study by ID
PUT
Update a study
POST
Update a study status

Participants

POST
Paginated list of participants in a study
POST
Import participants to a study

Teams

GET
Paginated list of teams in your workspace

Users

GET
Gets a paginated list of all users

Studies

Get paginated list of studies in your workspace.

Filtering currently not supported

POST

studies

Authorization

string

Bearer

Authorization

Required

string

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

object

pageInfo

object

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

Add Example Value

startCursor

string

startCursor

string

The cursor to start from

size

number

size

number

The number of items to return

Add Example Value

Authorizations

Authorization

string

headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

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

pageInfo.startCursor

string

The cursor to start from

pageInfo.size

number

default: 10

The number of items to return

Required range: 0 < x < 50

Response

200 - application/json

results

object[]

required

results.studyId

string

required

results.studyType

enum<string>

required

The type of study

Available options:

SURVEY,

INTERVIEWS,

UNMODERATED_TEST,

GROUP_INTERVIEW

results.recruitmentStrategy

enum<string>

required

The recruitment strategy for the study

Available options:

IN_RALLY,

EXTERNAL

results.status

enum<string>

required

The status of the study

Available options:

DRAFT,

ACTIVE,

PAUSED,

CLOSED

results.studyPlan

object

required

results.studyPlan.name

string | null

required

The internal name of the study

results.studyPlan.externalName

string | null

required

The external name of the study

results.studyPlan.description

string | null

required

The internal description of the study

results.studyPlan.externalDescription

string | null

required

The external description of the study

results.studyPlan.startDate

string | null

required

The start date of the study in ISO 8601 in UTC(with no offset)

results.studyPlan.endDate

string | null

required

The end date of the study in ISO 8601 in UTC(with no offset)

results.studyPlan.researchPlanUrl

string | null

required

The URL of the research plan

results.studyPlan.participationLimit

number | null

default: 10required

The participation limit of the study

results.studyPlan.consentFormId

string | null

required

The ID of the consent form

results.studyPlan.incentive

object | null

required

The incentive details for the study

results.studyPlan.incentive.incentiveType

enum<string>

required

The type of incentive

Available options:

MONEY_OR_GIFT_CARD,

MONEY_OR_GIFT_CARD_WITH_TREMENDOUS,

EXTERNAL_MONEY_OR_GIFT_CARD,

CHARITY,

CUSTOM,

RESPONDENT_MONEY,

RECRUITMENT_FEE

results.studyPlan.incentive.incentiveBudgetId

string | null

required

The ID of the incentive budget

results.studyPlan.incentive.amount

number | null

required

The amount of the incentive

results.studyPlan.includeScreener

boolean

required

Whether to include a screener. If type is SURVEY the default is true, if not then false

results.studyPlan.brandingConfigId

string | null

required

The ID of the branding configuration

results.studyPlan.language

enum<string>

default: enrequired

The language code for the study

Available options:

en,

es,

fr,

it,

ro,

pt,

pl,

de,

nl,

ja

total

number

required

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

Required range: x > 0

pageInfo

object

required

Information about the current page

pageInfo.hasNextPage

boolean

required

Whether there are additional pages of results

pageInfo.hasPreviousPage

boolean

required

Whether there is a prior page of results

pageInfo.startCursor

string

The start of the current page of results

pageInfo.endCursor

string

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

Create a new study Get a study by ID

x linkedin