People

Search for people

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

post/people/search

Request

  • Base URL: https://api.rallyuxr.com/api/public/v1
  • URL: https://api.rallyuxr.com/api/public/v1/people/search
  • Auth: HTTP bearer

Request body

attachPropertiesstring[]

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

allowlistInternalPropertiesstring[]

List of rally properties to include in the response. If this or blocklistInternalProperties is not included we will return all internal properties

blocklistInternalPropertiesstring[]

List of rally properties to exclude from the response

segmentIdsstring[]

List of segment IDs to filter people by

studyIdsstring[]

List of study IDs to filter people by

panelIdsstring[]

List of panel IDs to filter people by

peopleIdsstring[]

List of person IDs to filter people by

studyIdstring

The ID of the study to filter people by

Example request

{
  "attachProperties": [
    "custom_property_1"
  ],
  "filter": {
    "operator": "AND",
    "filters": [
      {
        "customProperty": {
          "propertyType": "MULTI_SELECT",
          "propertyGroup": "CUSTOM_PROPERTY",
          "propertyName": "CUSTOM_PROPERTY",
          "propertyId": "custom_property_1",
          "operator": "CONTAINS",
          "values": [
            "custom_property_option_1"
          ]
        }
      }
    ]
  },
  "pageInfo": {
    "size": 20
  }
}

Response

Successfully retrieved people

totalnumber required

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

Example response

{
  "results": [
    {
      "properties": [
        {
          "value": {
            "latitude": 37.7749,
            "longitude": -122.4194,
            "country": "US",
            "postalCode": "94103",
            "admin1": "CA",
            "admin2": "San Francisco",
            "admin3": "San Francisco"
          }
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.