Get Workplan Usage History

View the tokens consumed to by a workplan to generate reports starting from a specified date.

This endpoint returns the token usage of a workplan by day, along with the number of reports_created that day and returns the total reports_created and total_tokens_used for the workplan during that timeframe.

Authentication

x-api-keystring

Enter your API key here.

Path parameters

workplan_idstringRequired

from_datestringRequired

Response

Successful Response

workplan_idstring

The workplan id of the workplan requested/

usage_historylist of objects

A list of entries representing the number of runs and token usage for that time period/

reports_createdinteger

A number that represents the total number of reports created by the workplan between requested start/end dates.

total_tokens_usedinteger

A number that represents the total number of tokens used by the workplan between requested start/end dates.

1	import requests
2
3	url = "https://alfa.boosted.ai/client/v2/workplans/get-workplan-usage-history/workplan_id/from_date"
4
5	headers = {"x-api-key": "<apiKey>"}
6
7	response = requests.get(url, headers=headers)
8
9	print(response.json())

1	{
2	"workplan_id": "string",
3	"usage_history": [
4	{
5	"date": "string",
6	"report_tokens": 1,
7	"workplan_creation_tokens": 1,
8	"reports_created": 1
9	}
10	],
11	"reports_created": 1,
12	"total_tokens_used": 1
13	}

Authentication

Path parameters

Response

Errors