0

Get API Usage

by
Published Apr 8, 2025

Returns the detail on API usage on a bucket of a particular time period, group by method category.

Script telnyx Verified

The script

Submitted by hugo697 Bun
Verified 428 days ago
1
//native
2
type Telnyx = {
3
	apiKey: string
4
}
5
/**
6
 * Get API Usage
7
 * Returns the detail on API usage on a bucket of a particular time period, group by method category.
8
 */
9
export async function main(
10
	auth: Telnyx,
11
	bucketName: string,
12
	filter_start_time_: string | undefined,
13
	filter_end_time_: string | undefined
14
) {
15
	const url = new URL(`https://api.telnyx.com/v2/storage/buckets/${bucketName}/usage/api`)
16
	for (const [k, v] of [
17
		['filter[start_time]', filter_start_time_],
18
		['filter[end_time]', filter_end_time_]
19
	]) {
20
		if (v !== undefined && v !== '' && k !== undefined) {
21
			url.searchParams.append(k, v)
22
		}
23
	}
24
	const response = await fetch(url, {
25
		method: 'GET',
26
		headers: {
27
			Authorization: 'Bearer ' + auth.apiKey
28
		},
29
		body: undefined
30
	})
31
	if (!response.ok) {
32
		const text = await response.text()
33
		throw new Error(`${response.status} ${text}`)
34
	}
35
	return await response.json()
36
}
37