Get Query Count Data

GET

/api/v2/query-counts/

Analyticsv2

API endpoint for retrieving overall query count data aggregated by date.

Version:

2.0, 2.1

Changelog:

v2.0: Original API version for query count data.

v2.1: Added ISO formatted date field for more precise date handling.

GET Parameters:

type (str): Query type ('fixed' or 'range')
days (int): Number of days to look back (for 'fixed' type)
start_date (str): Start date in ISO format (for 'range' type)
end_date (str): End date in ISO format (for 'range' type)
time_series (bool): Whether to return data in time series format
bucket_type (str): Type of time bucket ('day', 'week', 'month')
limit (int): Number of top entities to return per date bucket (default: 10)

Headers:

X-API-Version (str, optional): API version to use (e.g., '2.0', '2.1'). Defaults to latest.

Returns:

JSON response containing query/interaction count data aggregated by date

Response Example

200 - Standard Response

{
    "success": true,
    "message": "Overall query  data retrieved successfully",
    "data": {
        "query_data": [
            [
                {
                    "date": "2024-05-01",
                    "interaction_count": 320
                },
                {
                    "date": "2024-05-02",
                    "interaction_count": 285
                },
                {
                    "date": "2024-05-03",
                    "interaction_count": 412
                }
            ]
        ]
    }
}

Request

Query Params

bucket_type

enum<string>

optional

Type of time bucket for time series data. Determines how data is grouped when time_series=true.

Allowed values:

daymonthweek

Default:

day

Example:

day

days

integer

optional

Number of days to look back from current date (only used when type=fixed)

Example:

end_date

string

optional

End date in ISO format (only used when type=range). Can be date only or include time.

Example:

2024-03-31

limit

integer

optional

Number of top entities to return per date bucket

Default:

Example:

start_date

string

optional

Start date in ISO format (only used when type=range). Can be date only or include time.

Example:

2024-03-01

time_series

boolean

optional

Whether to return data in time series format. When true, data will be grouped by the specified bucket_type.

Default:

false

Example:

true

type

enum<string>

optional

Query type for date range filtering. Use 'fixed' for relative time periods or 'range' for specific date ranges.

Allowed values:

fixedrange

Example:

fixed

Responses

🟢200OK

application/json

Body

success

boolean

optional

Default:

true

message

string

required

data

object

optional

Default:

{"query_data":[]}

Additional properties

array[object (OverallQueryCount) {2}]

optional

🟠403Forbidden

🟠405405

🔴500Server Error

Get Vote Count Data

Get Token Data