0

Get country's keyword metrics

by
Published Dec 20, 2024

See keyword metrics for a specified country, aggregated across all of Pinterest. (Definitions are available from the "Get delivery metrics definitions" API endpoint).

Script pinterest Verified

The script

Submitted by hugo697 Bun
Verified 536 days ago
1
//native
2
type Pinterest = {
3
  token: string;
4
};
5
/**
6
 * Get country's keyword metrics
7
 * See keyword metrics for a specified country, aggregated across all of Pinterest.
8
(Definitions are available from the "Get delivery metrics definitions"
9
API endpoint).
10
 */
11
export async function main(
12
  auth: Pinterest,
13
  ad_account_id: string,
14
  country_code: string | undefined,
15
  keywords: string | undefined,
16
) {
17
  const url = new URL(
18
    `https://api.pinterest.com/v5/ad_accounts/${ad_account_id}/keywords/metrics`,
19
  );
20
  for (const [k, v] of [
21
    ["country_code", country_code],
22
    ["keywords", keywords],
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