Get ranked list of users who match a persona definition.

post https://api.sandbox-65ebc.chico.ai/v1/persona/{persona_id}/users

Returns a ranked list of users who match a persona definition.

Users are sorted by their persona score, with the highest scoring users appearing first. Results are paginated
by default, with 500 users per page. You can specify the page number and page size by passing the page_number
and page_size query parameters. (e.g. GET /persona/{persona_id}/users?page_number=2&page_size=100)

You can also specify the minimum persona score threshold that a user must meet to be included in the response.
If not specified, will default to the hyperplane suggested threshold for the given persona_id.

You can also use a blocklist to exclude specific users from the response.

Path Params

persona_id

string

required

Persona ID

Query Params

page_number

integer

≥ 1

Defaults to 1

Page number, starting at 1

page_size

integer

1 to 10000

Defaults to 500

Number of users scored in run per page, between 1 and 10000. Defaults to 500.

month

string

Reference month for persona scores in YYYY-MM format. Defaults to current month.

persona_score_threshold

number

0 to 1

Minimum user persona score threshold for user to be included in the response.

Body Params

Optional user filters

birth_date

object

Definition of a filter on an attribute of timestamp type.

blocklist

array of strings

required

List of user ids to not be included in the response

blocklist*

branch

object

required

Filter branch based on a list of allowed values

cbo_code

object

Filter cbo code based on a list of allowed values

declared_monthly_income

object

Definition of a filter on an attribute of numerical type.

job_title

object

Filter job title based on a list of allowed values

Headers

module-id

string

Module ID

Responses

`persona_id` does not exist.

Language

Credentials

Header

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url 'https://api.sandbox-65ebc.chico.ai/v1/persona/persona_id/users?page_number=1&page_size=500' \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Ok

400Will return a 400 (Bad Request) error if the provided module ID or month is invalid.

404Will return a 404 (Not Found) error if the persona with provided persona_id does not exist.

`persona_id` does not exist.