Get Events Volume from Workspace

//native

type Segment = {

  token: string;

  baseUrl: string;

};

/**

 * Get Events Volume from Workspace

 * Enumerates the Workspace event volumes over time in minute increments.

The rate limit for this endpoint is 60 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See Rate Limiting for more information.

 */

export async function main(

  auth: Segment,

  granularity: "DAY" | "HOUR" | "MINUTE" | undefined,

  startTime: string | undefined,

  endTime: string | undefined,

  groupBy: string | undefined,

  sourceId: string | undefined,

  eventName: string | undefined,

  eventType: string | undefined,

  appVersion: string | undefined,

  pagination: string | undefined,

) {

  const url = new URL(`${auth.baseUrl}/events/volume`);

  for (const [k, v] of [

    ["granularity", granularity],

    ["startTime", startTime],

    ["endTime", endTime],

    ["groupBy", groupBy],

    ["sourceId", sourceId],

    ["eventName", eventName],

    ["eventType", eventType],

    ["appVersion", appVersion],

    ["pagination", pagination],

  ]) {

    if (v !== undefined && v !== "" && k !== undefined) {

      url.searchParams.append(k, v);

    }

  }

  const response = await fetch(url, {

    method: "GET",

    headers: {

      Authorization: "Bearer " + auth.token,

    },

    body: undefined,

  });

  if (!response.ok) {

    const text = await response.text();

    throw new Error(`${response.status} ${text}`);

  }

  return await response.json();

}