OCoctaneai
profiles

Find shopper profiles by what they answered

post/v1/profiles/search

Request

  • Base URL
    https://api.octaneai.com
  • Auth
    HTTP bearer

Query parameters

cursorstring nullable

From the previous page's next_cursor

limitinteger

Request body

quiz_idstring nullable

Only people who took this quiz

fromstring date nullable

Last seen on or after this UTC day

tostring date nullable

Last seen on or before this UTC day

has_orderboolean nullable

Placed an order we linked to a quiz session

has_emailboolean nullable

Has an email

has_phoneboolean nullable

Has a phone

has_marketing_consentboolean nullable

Ticked the marketing-consent checkbox beside their newest email or phone answer

is_returningboolean nullable

Took a quiz again after we first knew them, on any device

match'any_session' | 'latest_completed_per_quiz'

any_session: any time they took the quiz counts; latest_completed_per_quiz: only their latest completed take of each quiz

Example request

{
  "quiz_id": "quiz_7c9e6679742540de944be07fc1f90ae7",
  "groups": [
    {
      "all": [
        {
          "quiz_id": "quiz_7c9e6679742540de944be07fc1f90ae7"
        }
      ]
    }
  ]
}

Response

One page of the matching profiles, newest last-seen first; total is exact up to 5,000 and total_capped says when it stopped there.

has_moreboolean required

Whether another page follows

next_cursorstring nullable required

Send as cursor for the next page; null on the last

totalinteger required

How many profiles match

returning_totalinteger nullable required

How many of total came back; null once the total is capped

total_cappedboolean

A search stops counting at 5,000: total is then that cap, read it as 5,000+

Example response

{
  "data": [
    {
      "id": "prof_7c9e6679742540de944be07fc1f90ae7",
      "quizzes": [
        {
          "id": "quiz_7c9e6679742540de944be07fc1f90ae7"
        }
      ]
    }
  ]
}

Changes

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