0

Get library analytics action data.

by
Published Apr 8, 2025

Returns a list of library analytics actions data broken down by the requested dimension.

Script figma Verified

The script

Submitted by hugo697 Bun
Verified 428 days ago
1
//native
2
type Figma = {
3
  token: string;
4
};
5
/**
6
 * Get library analytics action data.
7
 * Returns a list of library analytics actions data broken down by the requested dimension.
8
 */
9
export async function main(
10
  auth: Figma,
11
  file_key: string,
12
  cursor: string | undefined,
13
  group_by: "component" | "team" | undefined,
14
  start_date: string | undefined,
15
  end_date: string | undefined,
16
  order: "asc" | "desc" | undefined,
17
) {
18
  const url = new URL(
19
    `https://api.figma.com/v1/analytics/libraries/${file_key}/actions`,
20
  );
21
  for (const [k, v] of [
22
    ["cursor", cursor],
23
    ["group_by", group_by],
24
    ["start_date", start_date],
25
    ["end_date", end_date],
26
    ["order", order],
27
  ]) {
28
    if (v !== undefined && v !== "" && k !== undefined) {
29
      url.searchParams.append(k, v);
30
    }
31
  }
32
  const response = await fetch(url, {
33
    method: "GET",
34
    headers: {
35
      Authorization: "Bearer " + auth.token,
36
    },
37
    body: undefined,
38
  });
39
  if (!response.ok) {
40
    const text = await response.text();
41
    throw new Error(`${response.status} ${text}`);
42
  }
43
  return await response.json();
44
}
45