0

Get usage reports

by
Published Apr 8, 2025

Fetch all messaging usage reports. Usage reports are aggregated messaging data for specified time period and breakdown

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 usage reports
7
 * Fetch all messaging usage reports. Usage reports are aggregated messaging data for specified time period and breakdown
8
 */
9
export async function main(
10
	auth: Telnyx,
11
	page_number_: string | undefined,
12
	page_size_: string | undefined
13
) {
14
	const url = new URL(`https://api.telnyx.com/v2/reports/mdr_usage_reports`)
15
	for (const [k, v] of [
16
		['page[number]', page_number_],
17
		['page[size]', page_size_]
18
	]) {
19
		if (v !== undefined && v !== '' && k !== undefined) {
20
			url.searchParams.append(k, v)
21
		}
22
	}
23
	const response = await fetch(url, {
24
		method: 'GET',
25
		headers: {
26
			Authorization: 'Bearer ' + auth.apiKey
27
		},
28
		body: undefined
29
	})
30
	if (!response.ok) {
31
		const text = await response.text()
32
		throw new Error(`${response.status} ${text}`)
33
	}
34
	return await response.json()
35
}
36