0

Get Reviews

by
Published Apr 8, 2025

Get all reviews.*Rate limits*:Burst: `10/s`Steady: `150/m` **Scopes:** `reviews:read`

Script klaviyo Verified

The script

Submitted by hugo697 Bun
Verified 428 days ago
1
//native
2
type Klaviyo = {
3
  apiKey: string;
4
};
5
/**
6
 * Get Reviews
7
 * Get all reviews.*Rate limits*:Burst: `10/s`Steady: `150/m`
8

9
 */
10
export async function main(
11
  auth: Klaviyo,
12
  fields_event_: string | undefined,
13
  fields_review_: string | undefined,
14
  filter: string | undefined,
15
  include: string | undefined,
16
  page_cursor_: string | undefined,
17
  page_size_: string | undefined,
18
  sort:
19
    | "created"
20
    | "-created"
21
    | "rating"
22
    | "-rating"
23
    | "updated"
24
    | "-updated"
25
    | undefined,
26
  revision: string,
27
) {
28
  const url = new URL(`https://a.klaviyo.com/api/reviews`);
29
  for (const [k, v] of [
30
    ["fields[event]", fields_event_],
31
    ["fields[review]", fields_review_],
32
    ["filter", filter],
33
    ["include", include],
34
    ["page[cursor]", page_cursor_],
35
    ["page[size]", page_size_],
36
    ["sort", sort],
37
  ]) {
38
    if (v !== undefined && v !== "" && k !== undefined) {
39
      url.searchParams.append(k, v);
40
    }
41
  }
42
  const response = await fetch(url, {
43
    method: "GET",
44
    headers: {
45
      revision: revision,
46
      "Accept": "application/vnd.api+json",
47
      Authorization: "Klaviyo-API-Key " + auth.apiKey,
48
    },
49
    body: undefined,
50
  });
51
  if (!response.ok) {
52
    const text = await response.text();
53
    throw new Error(`${response.status} ${text}`);
54
  }
55
  return await response.json();
56
}
57