AI

AI search for people

Search for people using a natural language prompt. Returns results and optional filter suggestions.

post/ai/people/search

Request

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

Request body

promptstring required

Natural language prompt to search for people

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

studyIdstring

The ID of the study to filter people by

Example request

{
  "prompt": "People in California who have done at least 3 studies",
  "attachProperties": [
    "EMAIL",
    "FIRST_NAME",
    "LAST_NAME"
  ],
  "allowlistInternalProperties": [
    "NAME",
    "CONTACT_STATUS",
    "OPTED_OUT"
  ],
  "pageInfo": {
    "size": 10
  }
}

Response

Successfully retrieved people

OR

Example response

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

Changes

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