GET
/
api
/
users
Make sure you add Api-Key prefix to your token

You can paste the command below into your terminal to run your first API request. Make sure to replace YOUR_KEYWORDSAI_API_KEY with your actual Keywords AI API key.

date
string
default:
"current time"

Date string in ISO format. Combined with summary_type, this will retrieve data from the time frame that contains this date.

summary_type
string

The range of data to retrieve. Possible values: all, daily, weekly, monthly, and yearly.

Example: summary_type=weekly, date=2024-03-09 00:00:00 will retrieve data for the week that contains 2024-03-09 00:00:00.

timezone_offset
int
default:
0

The timezone offset in hours is defined as UTC - local time. This helps you calibrate the date timeframe of your data.

Example: PST time is -8 hours from UTC, so the timezone_offset is 8.

Response params: