0

Get library analytics usage data.

by
Published Apr 8, 2025

Returns a list of library analytics usage 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 usage data.
7
 * Returns a list of library analytics usage 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" | "file" | undefined,
14
  order: "asc" | "desc" | undefined,
15
) {
16
  const url = new URL(
17
    `https://api.figma.com/v1/analytics/libraries/${file_key}/usages`,
18
  );
19
  for (const [k, v] of [
20
    ["cursor", cursor],
21
    ["group_by", group_by],
22
    ["order", order],
23
  ]) {
24
    if (v !== undefined && v !== "" && k !== undefined) {
25
      url.searchParams.append(k, v);
26
    }
27
  }
28
  const response = await fetch(url, {
29
    method: "GET",
30
    headers: {
31
      Authorization: "Bearer " + auth.token,
32
    },
33
    body: undefined,
34
  });
35
  if (!response.ok) {
36
    const text = await response.text();
37
    throw new Error(`${response.status} ${text}`);
38
  }
39
  return await response.json();
40
}
41