Get Speed Tests Histogram

type Cloudflare = {

  token: string;

  email: string;

  key: string;

};

/**

 * Get Speed Tests Histogram

 * Get an histogram from the previous 90 days of Cloudflare Speed Test data, split into fixed bandwidth (Mbps), latency (ms) or jitter (ms) buckets.

 */

export async function main(

  auth: Cloudflare,

  name: string | undefined,

  dateEnd: string | undefined,

  asn: string | undefined,

  location: string | undefined,

  bucketSize: string | undefined,

  metricGroup: "BANDWIDTH" | "LATENCY" | "JITTER" | undefined,

  format: "JSON" | "CSV" | undefined

) {

  const url = new URL(

    `https://api.cloudflare.com/client/v4/radar/quality/speed/histogram`

  );

  for (const [k, v] of [

    ["name", name],

    ["dateEnd", dateEnd],

    ["asn", asn],

    ["location", location],

    ["bucketSize", bucketSize],

    ["metricGroup", metricGroup],

    ["format", format],

  ]) {

    if (v !== undefined && v !== "") {

      url.searchParams.append(k, v);

    }

  }

  const response = await fetch(url, {

    method: "GET",

    headers: {

      "X-AUTH-EMAIL": auth.email,

      "X-AUTH-KEY": auth.key,

      Authorization: "Bearer " + auth.token,

    },

    body: undefined,

  });

  if (!response.ok) {

    const text = await response.text();

    throw new Error(`${response.status} ${text}`);

  }

  return await response.json();

}