/** * Klaviyo API * The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details. * * Contact: developers@klaviyo.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import { AxiosResponse } from "axios"; import { CampaignValuesRequestDTO } from '../model/campaignValuesRequestDTO'; import { FlowSeriesRequestDTO } from '../model/flowSeriesRequestDTO'; import { FlowValuesRequestDTO } from '../model/flowValuesRequestDTO'; import { FormSeriesRequestDTO } from '../model/formSeriesRequestDTO'; import { FormValuesRequestDTO } from '../model/formValuesRequestDTO'; import { PostCampaignValuesResponseDTO } from '../model/postCampaignValuesResponseDTO'; import { PostFlowSeriesResponseDTO } from '../model/postFlowSeriesResponseDTO'; import { PostFlowValuesResponseDTO } from '../model/postFlowValuesResponseDTO'; import { PostFormSeriesResponseDTO } from '../model/postFormSeriesResponseDTO'; import { PostFormValuesResponseDTO } from '../model/postFormValuesResponseDTO'; import { PostSegmentSeriesResponseDTO } from '../model/postSegmentSeriesResponseDTO'; import { PostSegmentValuesResponseDTO } from '../model/postSegmentValuesResponseDTO'; import { SegmentSeriesRequestDTO } from '../model/segmentSeriesRequestDTO'; import { SegmentValuesRequestDTO } from '../model/segmentValuesRequestDTO'; import { Session } from './apis'; export declare class ReportingApi { session: Session; protected _basePath: string; protected _defaultHeaders: any; protected _useQuerystring: boolean; constructor(session: Session); set useQuerystring(value: boolean); set basePath(basePath: string); set defaultHeaders(defaultHeaders: any); get defaultHeaders(): any; get basePath(): string; /** * Returns the requested campaign analytics values data

*Rate limits*:
Burst: `1/s`
Steady: `2/m`
Daily: `225/d` **Scopes:** `campaigns:read` * @summary Query Campaign Values * @param campaignValuesRequestDTO * @param pageCursor For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination */ queryCampaignValues(campaignValuesRequestDTO: CampaignValuesRequestDTO, options?: { pageCursor?: string; }): Promise<{ response: AxiosResponse; body: PostCampaignValuesResponseDTO; }>; /** * Returns the requested flow analytics series data

*Rate limits*:
Burst: `1/s`
Steady: `2/m`
Daily: `225/d` **Scopes:** `flows:read` * @summary Query Flow Series * @param flowSeriesRequestDTO * @param pageCursor For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination */ queryFlowSeries(flowSeriesRequestDTO: FlowSeriesRequestDTO, options?: { pageCursor?: string; }): Promise<{ response: AxiosResponse; body: PostFlowSeriesResponseDTO; }>; /** * Returns the requested flow analytics values data

*Rate limits*:
Burst: `1/s`
Steady: `2/m`
Daily: `225/d` **Scopes:** `flows:read` * @summary Query Flow Values * @param flowValuesRequestDTO * @param pageCursor For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination */ queryFlowValues(flowValuesRequestDTO: FlowValuesRequestDTO, options?: { pageCursor?: string; }): Promise<{ response: AxiosResponse; body: PostFlowValuesResponseDTO; }>; /** * Returns the requested form analytics series data.

*Rate limits*:
Burst: `1/s`
Steady: `2/m`
Daily: `225/d` **Scopes:** `forms:read` * @summary Query Form Series * @param formSeriesRequestDTO */ queryFormSeries(formSeriesRequestDTO: FormSeriesRequestDTO): Promise<{ response: AxiosResponse; body: PostFormSeriesResponseDTO; }>; /** * Returns the requested form analytics values data.

*Rate limits*:
Burst: `1/s`
Steady: `2/m`
Daily: `225/d` **Scopes:** `forms:read` * @summary Query Form Values * @param formValuesRequestDTO */ queryFormValues(formValuesRequestDTO: FormValuesRequestDTO): Promise<{ response: AxiosResponse; body: PostFormValuesResponseDTO; }>; /** * Returns the requested segment analytics series data.

*Rate limits*:
Burst: `1/s`
Steady: `2/m`
Daily: `225/d` **Scopes:** `segments:read` * @summary Query Segment Series * @param segmentSeriesRequestDTO */ querySegmentSeries(segmentSeriesRequestDTO: SegmentSeriesRequestDTO): Promise<{ response: AxiosResponse; body: PostSegmentSeriesResponseDTO; }>; /** * Returns the requested segment analytics values data.

*Rate limits*:
Burst: `1/s`
Steady: `2/m`
Daily: `225/d` **Scopes:** `segments:read` * @summary Query Segment Values * @param segmentValuesRequestDTO */ querySegmentValues(segmentValuesRequestDTO: SegmentValuesRequestDTO): Promise<{ response: AxiosResponse; body: PostSegmentValuesResponseDTO; }>; } export interface ReportingApi { /** * Alias of {@link ReportingApi.queryCampaignValues} * * @deprecated Use {@link ReportingApi.queryCampaignValues} instead */ createCampaignValueReport: typeof ReportingApi.prototype.queryCampaignValues; } export interface ReportingApi { /** * Alias of {@link ReportingApi.queryCampaignValues} * * @deprecated Use {@link ReportingApi.queryCampaignValues} instead */ createCampaignValuesReport: typeof ReportingApi.prototype.queryCampaignValues; } export interface ReportingApi { /** * Alias of {@link ReportingApi.queryFlowSeries} * * @deprecated Use {@link ReportingApi.queryFlowSeries} instead */ createFlowSeryReport: typeof ReportingApi.prototype.queryFlowSeries; } export interface ReportingApi { /** * Alias of {@link ReportingApi.queryFlowSeries} * * @deprecated Use {@link ReportingApi.queryFlowSeries} instead */ createFlowSeriesReport: typeof ReportingApi.prototype.queryFlowSeries; } export interface ReportingApi { /** * Alias of {@link ReportingApi.queryFlowValues} * * @deprecated Use {@link ReportingApi.queryFlowValues} instead */ createFlowValueReport: typeof ReportingApi.prototype.queryFlowValues; } export interface ReportingApi { /** * Alias of {@link ReportingApi.queryFlowValues} * * @deprecated Use {@link ReportingApi.queryFlowValues} instead */ createFlowValuesReport: typeof ReportingApi.prototype.queryFlowValues; } export interface ReportingApi { /** * Alias of {@link ReportingApi.queryFormSeries} * * @deprecated Use {@link ReportingApi.queryFormSeries} instead */ createFormSeryReport: typeof ReportingApi.prototype.queryFormSeries; } export interface ReportingApi { /** * Alias of {@link ReportingApi.queryFormSeries} * * @deprecated Use {@link ReportingApi.queryFormSeries} instead */ createFormSeriesReport: typeof ReportingApi.prototype.queryFormSeries; } export interface ReportingApi { /** * Alias of {@link ReportingApi.queryFormValues} * * @deprecated Use {@link ReportingApi.queryFormValues} instead */ createFormValueReport: typeof ReportingApi.prototype.queryFormValues; } export interface ReportingApi { /** * Alias of {@link ReportingApi.queryFormValues} * * @deprecated Use {@link ReportingApi.queryFormValues} instead */ createFormValuesReport: typeof ReportingApi.prototype.queryFormValues; } export interface ReportingApi { /** * Alias of {@link ReportingApi.querySegmentSeries} * * @deprecated Use {@link ReportingApi.querySegmentSeries} instead */ createSegmentSeryReport: typeof ReportingApi.prototype.querySegmentSeries; } export interface ReportingApi { /** * Alias of {@link ReportingApi.querySegmentSeries} * * @deprecated Use {@link ReportingApi.querySegmentSeries} instead */ createSegmentSeriesReport: typeof ReportingApi.prototype.querySegmentSeries; } export interface ReportingApi { /** * Alias of {@link ReportingApi.querySegmentValues} * * @deprecated Use {@link ReportingApi.querySegmentValues} instead */ createSegmentValueReport: typeof ReportingApi.prototype.querySegmentValues; } export interface ReportingApi { /** * Alias of {@link ReportingApi.querySegmentValues} * * @deprecated Use {@link ReportingApi.querySegmentValues} instead */ createSegmentValuesReport: typeof ReportingApi.prototype.querySegmentValues; }