User Profiling API | Besitos Knowledge Base

The User Profiling API provides demographic data about users, compiled from survey responses, offering you deeper insight into your user base. It is intended to be used with the Surveys API or Surveys iFrame.

Preparing to connect

Follow these steps to prepare to connect to Besitos APIs:

Have your partner ID ready.
Contact your Besitos Account Manager to request API access.
Set up postback.
Generate and save your bearer token for authentication.

Continue reading for a complete description of the API parameters and response attributes, or visit our Postman collection to start testing.

Endpoint

Endpoint URL	https://wall.besitos.ai/data/surveys/profiling/{partner_id}/{partner_user_id}
HTTP Method	GET
Refresh rate	60 minutes

Path parameters

Path parameter	Data type	Required	Description
`partner_id`	string	yes	Your Besitos partner ID.
`partner_user_id`	string	yes	The ID of a user in your database. Maximum 60 characters

Examples

Request

curl --location -g 'https://wall.besitos.ai/data/surveys/profiling/{partner_ID}/{partner_user_ID}' \
--header 'Accept: application/json' \
--data ''

Response

Responses can include questions and answers for over 60 profiling attributes. Those attributes are collected over time from users, rather than from a single survey. As a result, you may not receive answers to all available profiling questions in one response. For a complete list of profiling questions, please contact your Besitos Account Manager.

{
  "user_id": "uoAbiUbP9s3j",
  "data": [
    {
      "question": {
        "id": "9",
        "text": "Gender"
      },
      "answers": [
        {
          "id": 1,
          "text": "Female"
        }
      ]
    },
    {
      "question": {
        "id": "16",
        "text": "EmploymentStatus"
      },
      "answers": [
        {
          "id": 8,
          "text": "Self-employed part-time"
        }
      ]
    },
    {
      "question": {
        "id": "83",
        "text": "Age"
      },
      "answers": [
        {
          "id": "36",
          "text": "36"
        }
      ]
    },
    {
      "question": {
        "id": "12",
        "text": "RelationshipStatus"
      },
      "answers": [
        {
          "id": 2,
          "text": "Married"
        }
      ]
    },
    {
      "question": {
        "id": "37",
        "text": "Department"
      },
      "answers": []
    },
    {
      "question": {
        "id": "19",
        "text": "ChildrenList"
      },
      "answers": [
        {
          "id": 10,
          "text": "Boy age 4"
        },
        {
          "id": 17,
          "text": "Girl age 7"
        }
      ]
    },
    {
      "question": {
        "id": "86",
        "text": "UseMobile"
      },
      "answers": [
        {
          "id": 1,
          "text": "Yes"
        }
      ]
    },
    {
      "question": {
        "id": "85",
        "text": "UseTablet"
      },
      "answers": [
        {
          "id": 2,
          "text": "No"
        }
      ]
    },
    {
      "question": {
        "id": "15",
        "text": "TotalHouseholdIncome"
      },
      "answers": [
        {
          "id": 25,
          "text": "$20,000-$29,999"
        }
      ]
    },
    {
      "question": {
        "id": "10",
        "text": "HispanicLatinoOrSpanish"
      },
      "answers": [
        {
          "id": 1,
          "text": "No"
        }
      ]
    },
    {
      "question": {
        "id": "7",
        "text": "Zip"
      },
      "answers": [
        {
          "id": "80501",
          "text": "80501"
        }
      ]
    },
    {
      "question": {
        "id": "4",
        "text": "State"
      },
      "answers": [
        {
          "id": 6,
          "text": "Colorado"
        }
      ]
    },
    {
      "question": {
        "id": "88",
        "text": "Division"
      },
      "answers": []
    },
    {
      "question": {
        "id": "84",
        "text": "Dma"
      },
      "answers": [
        {
          "id": "751",
          "text": "751"
        }
      ]
    },
    {
      "question": {
        "id": "11",
        "text": "Race"
      },
      "answers": [
        {
          "id": 2,
          "text": "White/Caucasian"
        }
      ]
    },
    {
      "question": {
        "id": "87",
        "text": "Region"
      },
      "answers": [
        {
          "id": 4,
          "text": "West"
        }
      ]
    }
  ]
}

Response attributes

Attribute	Data Type	Description	Example
`user_id`	string	The ID of a user in your database.	`"uoAbiUbP9s3j"`
Question
`id`	string	Question ID	`"11"`
`text`	string	Question	`"Race"`
Answers
`id`	string	Unique identifier of the response	`2`
`text`	string	Response	`"White/Caucasian"`

Per our partner agreement, data handling is your responsibility as a Besitos partner.