User list
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 in ISO format. Combined with summary_type, this will retrieve data from the time frame that contains this date.
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.
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.
The number of UserData objects in the results array.
The URL to the next page of results.
The URL to the previous page of results.
Response params:
An array of UserData objects.
A summary of the data in request results (of all pages).