Get Segments

//native

type Klaviyo = {

  apiKey: string;

};

/**

 * Get Segments

 * Get all segments in an account.

Filter to request a subset of all segments. Segments can be filtered by `name`, `created`, and `updated` fields.

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

 */

export async function main(

  auth: Klaviyo,

  fields_flow_: string | undefined,

  fields_segment_: string | undefined,

  fields_tag_: string | undefined,

  filter: string | undefined,

  include: string | undefined,

  page_cursor_: string | undefined,

  sort:

    | "created"

    | "-created"

    | "id"

    | "-id"

    | "name"

    | "-name"

    | "updated"

    | "-updated"

    | undefined,

  revision: string,

) {

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

  for (const [k, v] of [

    ["fields[flow]", fields_flow_],

    ["fields[segment]", fields_segment_],

    ["fields[tag]", fields_tag_],

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

}