Skip to main content

API key stats


List API key stats

Get a list of API key stats information.

const response = await geocore.ApiKeyStats.apiStatsList({
apiKey: "apiKeyId",
startDate: "2025-01-01",
endDate: "2025-01-01",
page: 1,
limit: 10,
});

Prerequisites

Successfully get the IdToken with companyAdmin or superAdmin access level from login API.

Parameters

nametypedata typedescription
apiKeyrequiredstringAPI key ID to get stats
startDaterequiredstringSearch by API timestamps
endDaterequiredstringSearch by API timestamps
pagerequirednumberPage ordinal number
limitrequirednumberNumber of records per page
API key stats chart

Get API key stats chart information.

const response = await geocore.ApiKeyStats.reportStats({
apiKey: "apiKeyId",
startDate: "2025-01-01",
endDate: "2025-01-01",
groupBy: "month"
});

Prerequisites

Successfully get the IdToken with companyAdmin or superAdmin access level from login API.

Parameters

nametypedata typedescription
apiKeyrequiredstringAPI key ID to get stats
startDaterequiredstringSearch by API timestamps
endDaterequiredstringSearch by API timestamps
groupByrequiredstringCount stats by day or month