Query Form Values

//native

type Klaviyo = {

  apiKey: string;

};

/**

 * Query Form Values

 * Returns the requested form analytics values data.*Rate limits*:Burst: `1/s`Steady: `2/m`Daily: `225/d`

 */

export async function main(

  auth: Klaviyo,

  revision: string,

  body: {

    data: {

      type: "form-values-report";

      attributes: {

        statistics:

          | "closed_form"

          | "closed_form_uniques"

          | "qualified_form"

          | "qualified_form_uniques"

          | "submit_rate"

          | "submits"

          | "submitted_form_step"

          | "submitted_form_step_uniques"

          | "viewed_form"

          | "viewed_form_step"

          | "viewed_form_step_uniques"

          | "viewed_form_uniques"[];

        timeframe:

          | {

              key:

                | "last_12_months"

                | "last_30_days"

                | "last_365_days"

                | "last_3_months"

                | "last_7_days"

                | "last_90_days"

                | "last_month"

                | "last_week"

                | "last_year"

                | "this_month"

                | "this_week"

                | "this_year"

                | "today"

                | "yesterday";

            }

          | { start: string; end: string };

        group_by?: "form_id" | "form_version_id"[];

        filter?: string;

      };

    };

  },

) {

  const url = new URL(`https://a.klaviyo.com/api/form-values-reports`);

  const response = await fetch(url, {

    method: "POST",

    headers: {

      revision: revision,

      "Accept": "application/vnd.api+json",

      "Content-Type": "application/vnd.api+json",

      Authorization: "Klaviyo-API-Key " + auth.apiKey,

    },

    body: JSON.stringify(body),

  });

  if (!response.ok) {

    const text = await response.text();

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

  }

  return await response.json();

}