Get current aggregated analytics

Retrieves analytics aggregated from the last minute of usage on Spectrum applications underneath a given zone.

Script cloudflare Verified

by hugo697 ยท 11/16/2023

The script

Submitted by hugo697 Typescript (fetch-only)
Verified 383 days ago
1
type Cloudflare = {
2
  token: string;
3
  email: string;
4
  key: string;
5
};
6
/**
7
 * Get current aggregated analytics
8
 * Retrieves analytics aggregated from the last minute of usage on Spectrum applications underneath a given zone.
9
 */
10
export async function main(
11
  auth: Cloudflare,
12
  zone: string,
13
  appID: string | undefined,
14
  app_id_param: string | undefined,
15
  colo_name: string | undefined
16
) {
17
  const url = new URL(
18
    `https://api.cloudflare.com/client/v4/zones/${zone}/spectrum/analytics/aggregate/current`
19
  );
20
  for (const [k, v] of [
21
    ["appID", appID],
22
    ["app_id_param", app_id_param],
23
    ["colo_name", colo_name],
24
  ]) {
25
    if (v !== undefined && v !== "") {
26
      url.searchParams.append(k, v);
27
    }
28
  }
29
  const response = await fetch(url, {
30
    method: "GET",
31
    headers: {
32
      "X-AUTH-EMAIL": auth.email,
33
      "X-AUTH-KEY": auth.key,
34
      Authorization: "Bearer " + auth.token,
35
    },
36
    body: undefined,
37
  });
38
  if (!response.ok) {
39
    const text = await response.text();
40
    throw new Error(`${response.status} ${text}`);
41
  }
42
  return await response.json();
43
}
44