Get Metrics

//native

type Klaviyo = {

  apiKey: string;

};

/**

 * Get Metrics

 * Get all metrics in an account.

Requests can be filtered by the following fields:

integration `name`, integration `category`

Returns a maximum of 200 results per page.*Rate limits*:Burst: `10/s`Steady: `150/m`

 */

export async function main(

  auth: Klaviyo,

  fields_flow_: string | undefined,

  fields_metric_: string | undefined,

  filter: string | undefined,

  include: string | undefined,

  page_cursor_: string | undefined,

  revision: string,

) {

  const url = new URL(`https://a.klaviyo.com/api/metrics`);

  for (const [k, v] of [

    ["fields[flow]", fields_flow_],

    ["fields[metric]", fields_metric_],

    ["filter", filter],

    ["include", include],

    ["page[cursor]", page_cursor_],

  ]) {

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

      url.searchParams.append(k, v);

    }

  }

  const response = await fetch(url, {

    method: "GET",

    headers: {

      revision: revision,

      "Accept": "application/vnd.api+json",

      Authorization: "Klaviyo-API-Key " + auth.apiKey,

    },

    body: undefined,

  });

  if (!response.ok) {

    const text = await response.text();

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

  }

  return await response.json();

}