Class StatisticsApi

Constructors

new StatisticsApi(configuration, requestFactory?, responseProcessor?): StatisticsApi
Parameters
- configuration: Configuration<ObservableMiddleware>
- OptionalrequestFactory: StatisticsApiRequestFactory
- OptionalresponseProcessor: StatisticsApiResponseProcessor
Returns StatisticsApi
- Defined in codegen/marketing/emails/types/PromiseAPI.ts:848

getEmailsList(startTimestamp?, endTimestamp?, emailIds?, property?, _options?): Promise<AggregateEmailStatistics>
Use this endpoint to get aggregated statistics of emails sent in a specified time span. It also returns the list of emails that were sent during the time span. Get aggregated statistics.
Parameters
- OptionalstartTimestamp: string
  The start timestamp of the time span, in ISO8601 representation.
- OptionalendTimestamp: string
  The end timestamp of the time span, in ISO8601 representation.
- OptionalemailIds: number[]
  Filter by email IDs. Only include statistics of emails with these IDs.
- Optionalproperty: string
  Specifies which email properties should be returned. All properties will be returned by default.
- Optional_options: PromiseConfigurationOptions
Returns Promise<AggregateEmailStatistics>
- Defined in codegen/marketing/emails/types/PromiseAPI.ts:889

getEmailsListWithHttpInfo(startTimestamp?, endTimestamp?, emailIds?, property?, _options?): Promise<HttpInfo<AggregateEmailStatistics>>
Use this endpoint to get aggregated statistics of emails sent in a specified time span. It also returns the list of emails that were sent during the time span. Get aggregated statistics.
Parameters
- OptionalstartTimestamp: string
  The start timestamp of the time span, in ISO8601 representation.
- OptionalendTimestamp: string
  The end timestamp of the time span, in ISO8601 representation.
- OptionalemailIds: number[]
  Filter by email IDs. Only include statistics of emails with these IDs.
- Optionalproperty: string
  Specifies which email properties should be returned. All properties will be returned by default.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<AggregateEmailStatistics>>
- Defined in codegen/marketing/emails/types/PromiseAPI.ts:864

getHistogram(interval?, startTimestamp?, endTimestamp?, emailIds?, _options?): Promise<CollectionResponseWithTotalEmailStatisticIntervalNoPaging>
Get aggregated statistics in intervals for a specified time span. Each interval contains aggregated statistics of the emails that were sent in that time. Get aggregated statistic intervals.
Parameters
- Optionalinterval:
      | "MONTH"
      | "QUARTER"
      | "WEEK"
      | "YEAR"
      | "DAY"
      | "HOUR"
      | "QUARTER_HOUR"
      | "MINUTE"
      | "SECOND"
  The interval to aggregate statistics for.
- OptionalstartTimestamp: string
  The start timestamp of the time span, in ISO8601 representation.
- OptionalendTimestamp: string
  The end timestamp of the time span, in ISO8601 representation.
- OptionalemailIds: number[]
  Filter by email IDs. Only include statistics of emails with these IDs.
- Optional_options: PromiseConfigurationOptions
Returns Promise<CollectionResponseWithTotalEmailStatisticIntervalNoPaging>
- Defined in codegen/marketing/emails/types/PromiseAPI.ts:939

getHistogramWithHttpInfo(interval?, startTimestamp?, endTimestamp?, emailIds?, _options?): Promise<HttpInfo<CollectionResponseWithTotalEmailStatisticIntervalNoPaging>>
Get aggregated statistics in intervals for a specified time span. Each interval contains aggregated statistics of the emails that were sent in that time. Get aggregated statistic intervals.
Parameters
- Optionalinterval:
      | "MONTH"
      | "QUARTER"
      | "WEEK"
      | "YEAR"
      | "DAY"
      | "HOUR"
      | "QUARTER_HOUR"
      | "MINUTE"
      | "SECOND"
  The interval to aggregate statistics for.
- OptionalstartTimestamp: string
  The start timestamp of the time span, in ISO8601 representation.
- OptionalendTimestamp: string
  The end timestamp of the time span, in ISO8601 representation.
- OptionalemailIds: number[]
  Filter by email IDs. Only include statistics of emails with these IDs.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<CollectionResponseWithTotalEmailStatisticIntervalNoPaging>>
- Defined in codegen/marketing/emails/types/PromiseAPI.ts:914