To have better user observability, you can create new users using customr_params in your API call or use our User Creation endpoint.

​
Pass customer_params in your API call

After you pass the customer_params parameter in your API call, you can monitor the user’s data in the Keywords AI platform. See how to get insights into your users’ data here

​
Example code

{
    //...other_params,
    "customer_params": {
        "customer_identifier": "customer_123",
        "name": "Hendrix Liu", //optional
        "email": "hendrix@keywordsai.co" //optional
    }
}

​
All parameters

customer_identifier
string
required

The unique identifier for the customer. It can be any string.

name
string

The name of the customer. It can be any string.

email
string

The email of the customer. It shoud be a valid email.

period_start
string

The start date of the period. It should be in the format YYYY-MM-DD.

period_end
string

The start date of the period. It should be in the format YYYY-MM-DD.

budget_duration
string

Choices are yearly, monthly, weekly, and daily

period_budget
float

The budget for the period. It should be a float.

markup_percentage
float

The markup percentage for the period. Usage report of your customers through this key will be increased by this percentge.

total_budget
float

The total budget for a user.

​
Detailed example

​
User creation Endpoint

Use the User Creation endpoint instead of our other endpoints
url = "https://api.keywordsai.co/api/users/create/"

For more inforation about customer_identifier, check out the parameter here

RetriesUser data