Get Events

//native

type Klaviyo = {

  apiKey: string;

};

/**

 * Get Events

 * Get all events in an account

Requests can be sorted by the following fields:

`datetime`, `timestamp`

Returns a maximum of 200 events per page.*Rate limits*:Burst: `350/s`Steady: `3500/m`

 */

export async function main(

  auth: Klaviyo,

  fields_event_: string | undefined,

  fields_metric_: string | undefined,

  fields_profile_: string | undefined,

  filter: string | undefined,

  include: string | undefined,

  page_cursor_: string | undefined,

  sort: "datetime" | "-datetime" | "timestamp" | "-timestamp" | undefined,

  revision: string,

) {

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

  for (const [k, v] of [

    ["fields[event]", fields_event_],

    ["fields[metric]", fields_metric_],

    ["fields[profile]", fields_profile_],

    ["filter", filter],

    ["include", include],

    ["page[cursor]", page_cursor_],

    ["sort", sort],

  ]) {

    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();

}