API stats

---

List API stats

Get a list of API stats information.

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

Prerequisites

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

Parameters

name	type	data type	description
companyId	optional	string	Company ID to get API stats
startDate	optional	string	Search by API timestamps
endDate	optional	string	Search by API timestamps
page	optional	number	Page ordinal number
limit	optional	number	Number of records per page

API stats chart

Get API stats chart information.

const response = await geocore.ApiStats.reportStatsList({
  companyId: "companyId",
  startDate: "2025-01-01",
  endDate: "2025-01-01",
  groupBy: "month"
});

Prerequisites

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

Parameters

name	type	data type	description
companyId	optional	string	Company ID to get API stats
startDate	optional	string	Search by API timestamps
endDate	optional	string	Search by API timestamps
groupBy	optional	string	Count API stats by day or month

Network stats data

Get network in/out stats data information.

const response = await geocore.ApiStats.reportNetworkStats({
  companyId: "companyId",
  startDate: "2025-01-01",
  endDate: "2025-01-01"
});

Prerequisites

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

Parameters

name	type	data type	description
companyId	optional	string	Company ID to get API stats
startDate	optional	string	Search by API timestamps
endDate	optional	string	Search by API timestamps

Monthly active users

Get monthly active users stats.

const response = await geocore.ApiStats.monthlyActiveUser({
  companyIds: ["companyId"],
  startDate: "2025-01-01",
  endDate: "2025-01-01"
});

Prerequisites

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

Parameters

name	type	data type	description
companyIds	optional	array<string>	Company IDs to get MAU stats
startDate	optional	string	Search by MAU timestamps
endDate	optional	string	Search by MAU timestamps