Get Summary
Interaction
Get Summary
Endpoint to retrieve summarized interaction counts over a specified date range, grouped by daily, weekly, or monthly intervals.
Optionally filters by API titles and supports flexible time granularity in results.
Args:
request (SummaryRequest): The request body containing filter options:
- start_date (datetime): Start date of the summary range.
- end_date (datetime): End date of the summary range.
- api_title (List[str], optional): List of API titles to filter by.
- time_frame (str, optional): Time granularity - 'daily', 'weekly', or 'monthly'.
Returns:
dict: A dictionary mapping time buckets (daily/weekly/monthly) to counts of interactions,
either grouped by API title or as a total count.
Example Response:
{
"2024-04-01": {"API A": 12, "API B": 8},
"2024-04-02": {"API A": 9, "API B": 5}
}
POST
Get Summary
Authorizations
JWT Authorization header using the Bearer scheme. Example: 'Authorization: Bearer {token}'
Body
application/json
Response
Successful Response
