OCoctaneai
profiles

Get a shopper profile

get/v1/profiles/{profile_id}

Request

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

Path parameters

profile_idstring required

Response

The shopper's identities, latest answers and results, sessions, and linked orders.

idstring required

The profile

removedboolean required

True once the shopper's data was erased on a data-deletion request: no identities or contact values remain

removed_atstring date-time nullable required

When the data was erased; null otherwise

first_seen_atstring date-time nullable required

The start of the shopper's first session; null when not known

last_seen_atstring date-time required

The latest moment the shopper was seen

sessions_countinteger required

How many quiz sessions the shopper had

completed_countinteger required

How many of them completed

returningboolean nullable required

True when the shopper took a quiz again after we first knew them, on any device; null on a removed profile

returning_countinteger nullable required

Sessions that began after we first knew the shopper; null on a removed profile

quizzes_taken_countinteger required

How many different quizzes the shopper took

orders_countinteger required

Orders linked to the shopper's quiz sessions

last_order_atstring date-time nullable required

When the latest of them was placed; null without orders

Example response

{
  "id": "prof_7c9e6679742540de944be07fc1f90ae7",
  "latest_results": [
    {
      "quiz_id": "quiz_7c9e6679742540de944be07fc1f90ae7",
      "session_id": "sess_7c9e6679742540de944be07fc1f90ae7",
      "result_page": {
        "shown_products": [
          {
            "product_id": "gid://shopify/Product/8692896989320",
            "variant_id": "gid://shopify/ProductVariant/40926435967056"
          }
        ]
      }
    }
  ],
  "sessions": [
    {
      "session_id": "sess_7c9e6679742540de944be07fc1f90ae7",
      "quiz_id": "quiz_7c9e6679742540de944be07fc1f90ae7",
      "source_session_id": "sess_7c9e6679742540de944be07fc1f90ae7",
      "source_kind": "share"
    }
  ],
  "orders": [
    {
      "quiz_id": "quiz_7c9e6679742540de944be07fc1f90ae7",
      "session_id": "sess_7c9e6679742540de944be07fc1f90ae7"
    }
  ],
  "share_orders": [
    {
      "quiz_id": "quiz_7c9e6679742540de944be07fc1f90ae7",
      "session_id": "sess_7c9e6679742540de944be07fc1f90ae7",
      "buyer_person_id": "prof_7c9e6679742540de944be07fc1f90ae7"
    }
  ]
}

Changes

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