Get Profiles for Segment

//native

type Klaviyo = {

  apiKey: string;

};

/**

 * Get Profiles for Segment

 * Get all profiles within a segment with the given segment ID.

Filter to request a subset of all profiles. Profiles can be filtered by `email`, `phone_number`, `push_token`, and `joined_group_at` fields. Profiles can be sorted by the following fields, in ascending and descending order: `joined_group_at`*Rate limits*:Burst: `75/s`Steady: `700/m`

 */

export async function main(

  auth: Klaviyo,

  id: string,

  additional_fields_profile_: string | undefined,

  fields_profile_: string | undefined,

  filter: string | undefined,

  page_cursor_: string | undefined,

  page_size_: string | undefined,

  sort: "joined_group_at" | "-joined_group_at" | undefined,

  revision: string,

) {

  const url = new URL(`https://a.klaviyo.com/api/segments/${id}/profiles`);

  for (const [k, v] of [

    ["additional-fields[profile]", additional_fields_profile_],

    ["fields[profile]", fields_profile_],

    ["filter", filter],

    ["page[cursor]", page_cursor_],

    ["page[size]", page_size_],

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

}