Skip to main content
POST
/
messages
/
emails
/
search
Search for emails
curl --request POST \
  --url https://api.rallyuxr.com/api/public/v1/messages/emails/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "filter": {
    "operator": "AND",
    "filters": [
      {
        "message": {
          "propertyType": "SINGLE_SELECT",
          "propertyName": "EMAIL_STATUS",
          "operator": "IS",
          "value": "DELIVERED"
        }
      },
      {
        "message": {
          "propertyType": "DATETIME",
          "propertyName": "SENT_AT",
          "operator": "IS_WITHIN",
          "value": "NUMBER_OF_DAYS_AGO",
          "amount": 7
        }
      },
      {
        "person": {
          "propertyType": "STRING",
          "propertyName": "EMAIL",
          "operator": "CONTAINS",
          "value": "@example.com"
        }
      }
    ]
  },
  "studyId": "<string>",
  "teamId": "<string>",
  "userId": "<string>",
  "populationId": "<string>",
  "pageInfo": {
    "size": 10
  }
}
'
import requests

url = "https://api.rallyuxr.com/api/public/v1/messages/emails/search"

payload = {
    "filter": {
        "operator": "AND",
        "filters": [{ "message": {
                    "propertyType": "SINGLE_SELECT",
                    "propertyName": "EMAIL_STATUS",
                    "operator": "IS",
                    "value": "DELIVERED"
                } }, { "message": {
                    "propertyType": "DATETIME",
                    "propertyName": "SENT_AT",
                    "operator": "IS_WITHIN",
                    "value": "NUMBER_OF_DAYS_AGO",
                    "amount": 7
                } }, { "person": {
                    "propertyType": "STRING",
                    "propertyName": "EMAIL",
                    "operator": "CONTAINS",
                    "value": "@example.com"
                } }]
    },
    "studyId": "<string>",
    "teamId": "<string>",
    "userId": "<string>",
    "populationId": "<string>",
    "pageInfo": { "size": 10 }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    filter: {
      operator: 'AND',
      filters: [
        {
          message: {
            propertyType: 'SINGLE_SELECT',
            propertyName: 'EMAIL_STATUS',
            operator: 'IS',
            value: 'DELIVERED'
          }
        },
        {
          message: {
            propertyType: 'DATETIME',
            propertyName: 'SENT_AT',
            operator: 'IS_WITHIN',
            value: 'NUMBER_OF_DAYS_AGO',
            amount: 7
          }
        },
        {
          person: {
            propertyType: 'STRING',
            propertyName: 'EMAIL',
            operator: 'CONTAINS',
            value: '@example.com'
          }
        }
      ]
    },
    studyId: '<string>',
    teamId: '<string>',
    userId: '<string>',
    populationId: '<string>',
    pageInfo: {size: 10}
  })
};

fetch('https://api.rallyuxr.com/api/public/v1/messages/emails/search', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.rallyuxr.com/api/public/v1/messages/emails/search",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'filter' => [
        'operator' => 'AND',
        'filters' => [
                [
                                'message' => [
                                                                'propertyType' => 'SINGLE_SELECT',
                                                                'propertyName' => 'EMAIL_STATUS',
                                                                'operator' => 'IS',
                                                                'value' => 'DELIVERED'
                                ]
                ],
                [
                                'message' => [
                                                                'propertyType' => 'DATETIME',
                                                                'propertyName' => 'SENT_AT',
                                                                'operator' => 'IS_WITHIN',
                                                                'value' => 'NUMBER_OF_DAYS_AGO',
                                                                'amount' => 7
                                ]
                ],
                [
                                'person' => [
                                                                'propertyType' => 'STRING',
                                                                'propertyName' => 'EMAIL',
                                                                'operator' => 'CONTAINS',
                                                                'value' => '@example.com'
                                ]
                ]
        ]
    ],
    'studyId' => '<string>',
    'teamId' => '<string>',
    'userId' => '<string>',
    'populationId' => '<string>',
    'pageInfo' => [
        'size' => 10
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.rallyuxr.com/api/public/v1/messages/emails/search"

	payload := strings.NewReader("{\n  \"filter\": {\n    \"operator\": \"AND\",\n    \"filters\": [\n      {\n        \"message\": {\n          \"propertyType\": \"SINGLE_SELECT\",\n          \"propertyName\": \"EMAIL_STATUS\",\n          \"operator\": \"IS\",\n          \"value\": \"DELIVERED\"\n        }\n      },\n      {\n        \"message\": {\n          \"propertyType\": \"DATETIME\",\n          \"propertyName\": \"SENT_AT\",\n          \"operator\": \"IS_WITHIN\",\n          \"value\": \"NUMBER_OF_DAYS_AGO\",\n          \"amount\": 7\n        }\n      },\n      {\n        \"person\": {\n          \"propertyType\": \"STRING\",\n          \"propertyName\": \"EMAIL\",\n          \"operator\": \"CONTAINS\",\n          \"value\": \"@example.com\"\n        }\n      }\n    ]\n  },\n  \"studyId\": \"<string>\",\n  \"teamId\": \"<string>\",\n  \"userId\": \"<string>\",\n  \"populationId\": \"<string>\",\n  \"pageInfo\": {\n    \"size\": 10\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.rallyuxr.com/api/public/v1/messages/emails/search")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"filter\": {\n    \"operator\": \"AND\",\n    \"filters\": [\n      {\n        \"message\": {\n          \"propertyType\": \"SINGLE_SELECT\",\n          \"propertyName\": \"EMAIL_STATUS\",\n          \"operator\": \"IS\",\n          \"value\": \"DELIVERED\"\n        }\n      },\n      {\n        \"message\": {\n          \"propertyType\": \"DATETIME\",\n          \"propertyName\": \"SENT_AT\",\n          \"operator\": \"IS_WITHIN\",\n          \"value\": \"NUMBER_OF_DAYS_AGO\",\n          \"amount\": 7\n        }\n      },\n      {\n        \"person\": {\n          \"propertyType\": \"STRING\",\n          \"propertyName\": \"EMAIL\",\n          \"operator\": \"CONTAINS\",\n          \"value\": \"@example.com\"\n        }\n      }\n    ]\n  },\n  \"studyId\": \"<string>\",\n  \"teamId\": \"<string>\",\n  \"userId\": \"<string>\",\n  \"populationId\": \"<string>\",\n  \"pageInfo\": {\n    \"size\": 10\n  }\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.rallyuxr.com/api/public/v1/messages/emails/search")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"filter\": {\n    \"operator\": \"AND\",\n    \"filters\": [\n      {\n        \"message\": {\n          \"propertyType\": \"SINGLE_SELECT\",\n          \"propertyName\": \"EMAIL_STATUS\",\n          \"operator\": \"IS\",\n          \"value\": \"DELIVERED\"\n        }\n      },\n      {\n        \"message\": {\n          \"propertyType\": \"DATETIME\",\n          \"propertyName\": \"SENT_AT\",\n          \"operator\": \"IS_WITHIN\",\n          \"value\": \"NUMBER_OF_DAYS_AGO\",\n          \"amount\": 7\n        }\n      },\n      {\n        \"person\": {\n          \"propertyType\": \"STRING\",\n          \"propertyName\": \"EMAIL\",\n          \"operator\": \"CONTAINS\",\n          \"value\": \"@example.com\"\n        }\n      }\n    ]\n  },\n  \"studyId\": \"<string>\",\n  \"teamId\": \"<string>\",\n  \"userId\": \"<string>\",\n  \"populationId\": \"<string>\",\n  \"pageInfo\": {\n    \"size\": 10\n  }\n}"

response = http.request(request)
puts response.read_body
{
  "results": [
    {
      "id": "<string>",
      "recipientId": "<string>",
      "senderId": "<string>",
      "status": "<string>",
      "type": "<string>",
      "sentAt": "2023-11-07T05:31:56Z",
      "scheduledSendTime": "2023-11-07T05:31:56Z",
      "studyId": "<string>",
      "participantId": "<string>",
      "messageCampaignId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "recipientEmail": "<string>",
      "senderEmail": "<string>",
      "subject": "<string>"
    }
  ],
  "total": 123,
  "pageInfo": {
    "hasNextPage": true,
    "hasPreviousPage": true,
    "startCursor": "<string>",
    "endCursor": "<string>"
  }
}
{
  "errors": [
    {
      "message": "<string>",
      "path": [
        "<string>"
      ]
    }
  ]
}
"Unauthorized"
"Forbidden"
"Too Many Requests"
"Internal Server Error"

Authorizations

​
Authorization
string
header
required

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

Body

application/json

Search for messages

​
filter
object

Filter options to search for messages. Supports person, incentive, participant, and message property filters.

Example:
{
  "operator": "AND",
  "filters": [
    {
      "message": {
        "propertyType": "SINGLE_SELECT",
        "propertyName": "EMAIL_STATUS",
        "operator": "IS",
        "value": "DELIVERED"
      }
    },
    {
      "message": {
        "propertyType": "DATETIME",
        "propertyName": "SENT_AT",
        "operator": "IS_WITHIN",
        "value": "NUMBER_OF_DAYS_AGO",
        "amount": 7
      }
    },
    {
      "person": {
        "propertyType": "STRING",
        "propertyName": "EMAIL",
        "operator": "CONTAINS",
        "value": "@example.com"
      }
    }
  ]
}
​
studyId
string

Filter messages by study ID

​
teamId
string

Filter messages by team ID

​
userId
string

Filter messages by sender user ID

​
populationId
string

Filter messages by population ID

​
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

Example:
{ "size": 10 }

Response

Successfully retrieved emails

Response for a search of emails

​
results
object[]
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