Get paginated list of studies in your workspace.
Get a paginated list of studies in your workspace
curl --request POST \
--url https://api.rallyuxr.com/api/public/v1/studies/search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"filter": {
"operator": "AND",
"filters": [
{
"propertyType": "DATETIME",
"propertyGroup": "STUDY",
"propertyName": "CREATED",
"operator": "IS",
"value": "TODAY",
"timestamp": 123,
"exactDate": "<string>",
"days": 123
}
]
},
"pageInfo": {
"size": 10
}
}'{
"results": [
{
"studyId": "<string>",
"studyType": "SURVEY",
"recruitmentStrategy": "IN_RALLY",
"status": "DRAFT",
"studyPlan": {
"name": "<string>",
"externalName": "<string>",
"description": "<string>",
"externalDescription": "<string>",
"startDate": "2025-01-01",
"endDate": "2025-01-02",
"researchPlanUrl": "<string>",
"participationLimit": 10,
"consentFormId": "<string>",
"incentive": {
"incentiveType": "MONEY_OR_GIFT_CARD",
"incentiveBudgetId": "<string>",
"amount": 123,
"customIncentiveId": "<string>",
"defaultCustomIncentiveValue": "<string>"
},
"includeScreener": true,
"brandingConfigId": "<string>",
"language": "en"
},
"createdAt": "2023-11-07T05:31:56Z"
}
],
"total": 123,
"pageInfo": {
"hasNextPage": true,
"hasPreviousPage": true,
"startCursor": "<string>",
"endCursor": "<string>"
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
Filter option to search for studies
DATETIME STUDY CREATED, UPDATED, START_DATE, END_DATE IS, IS_NOT, IS_BEFORE, IS_AFTER, IS_ON_OR_BEFORE, IS_ON_OR_AFTER, IS_WITHIN, IS_EMPTY, IS_NOT_EMPTY The value of the date being searched for. All dates are relative to workspace timezone
TODAY, TOMORROW, YESTERDAY, ONE_WEEK_AGO, ONE_WEEK_FROM_NOW, ONE_MONTH_AGO, ONE_MONTH_FROM_NOW, ONE_YEAR_AGO, ONE_YEAR_FROM_NOW, NUMBER_OF_DAYS_AGO, NUMBER_OF_DAYS_FROM_NOW, EXACT_DATE Deprecated since use of this value can be confusing. The timestamp of a date in UTC milliseconds. This uses the date value of the timestamp by truncating to the day. Filtering for exact times is not supported. Requires EXACT_DATE value
A date string in yyyy-MM-dd. Requires EXACT_DATE value
AND, OR 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
Response
Study object
The type of study
SURVEY, INTERVIEWS, UNMODERATED_TEST, GROUP_INTERVIEW The recruitment strategy for the study
IN_RALLY, EXTERNAL The status of the study
DRAFT, ACTIVE, PAUSED, CLOSED Study plan object
The internal name of the study
The external name of the study
The internal description of the study
The external description of the study
The start date of the study in YYYY-MM-DD format
"2025-01-01"
The end date of the study in YYYY-MM-DD format
"2025-01-02"
The URL of the research plan
The participation limit of the study
The ID of the consent form
The incentive details for the study
The type of incentive
MONEY_OR_GIFT_CARD, MONEY_OR_GIFT_CARD_WITH_TREMENDOUS, EXTERNAL_MONEY_OR_GIFT_CARD, CHARITY, CUSTOM, RESPONDENT_MONEY, RECRUITMENT_FEE The ID of the incentive budget
The amount of the incentive
If type is CUSTOM then the ID of the custom incentive
If type is CUSTOM then the default value of the custom incentive
Whether to include a screener. If type is SURVEY the default is true, if not then false
The ID of the branding configuration
The language code for the study
en, es, fr, it, ro, pt, pl, de, nl, ja, pt_BR, ko The total number of items in your workspaces based on your search parameters
x > 0Information about the current page
Whether there are additional pages of results
Whether there is a prior page of results
The start of the current page of results
The end of the current page of results. Use to fetch the next page
curl --request POST \
--url https://api.rallyuxr.com/api/public/v1/studies/search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"filter": {
"operator": "AND",
"filters": [
{
"propertyType": "DATETIME",
"propertyGroup": "STUDY",
"propertyName": "CREATED",
"operator": "IS",
"value": "TODAY",
"timestamp": 123,
"exactDate": "<string>",
"days": 123
}
]
},
"pageInfo": {
"size": 10
}
}'{
"results": [
{
"studyId": "<string>",
"studyType": "SURVEY",
"recruitmentStrategy": "IN_RALLY",
"status": "DRAFT",
"studyPlan": {
"name": "<string>",
"externalName": "<string>",
"description": "<string>",
"externalDescription": "<string>",
"startDate": "2025-01-01",
"endDate": "2025-01-02",
"researchPlanUrl": "<string>",
"participationLimit": 10,
"consentFormId": "<string>",
"incentive": {
"incentiveType": "MONEY_OR_GIFT_CARD",
"incentiveBudgetId": "<string>",
"amount": 123,
"customIncentiveId": "<string>",
"defaultCustomIncentiveValue": "<string>"
},
"includeScreener": true,
"brandingConfigId": "<string>",
"language": "en"
},
"createdAt": "2023-11-07T05:31:56Z"
}
],
"total": 123,
"pageInfo": {
"hasNextPage": true,
"hasPreviousPage": true,
"startCursor": "<string>",
"endCursor": "<string>"
}
}