Class ApiInboxPlacementTestControllerApi

Hierarchy

BaseAPI
- ApiInboxPlacementTestControllerApi

Constructors

constructor

new ApiInboxPlacementTestControllerApi(configuration?: Configuration): ApiInboxPlacementTestControllerApi
Parameters
- configuration: Configuration = ...
Returns ApiInboxPlacementTestControllerApi

Inherited from BaseAPI.constructor

Properties

`Protected` configuration

configuration: Configuration = ...

Methods

createInboxPlacementTest

createInboxPlacementTest(requestParameters: CreateInboxPlacementTestRequest, initOverrides?: RequestInit): Promise<InboxPlacementTestRunDto>
Create a new direct-send inbox placement test
Parameters
- requestParameters: CreateInboxPlacementTestRequest
- Optional initOverrides: RequestInit
Returns Promise<InboxPlacementTestRunDto>

createInboxPlacementTestRaw

createInboxPlacementTestRaw(requestParameters: CreateInboxPlacementTestRequest, initOverrides?: RequestInit): Promise<ApiResponse<InboxPlacementTestRunDto>>
Create a new direct-send inbox placement test
Parameters
- requestParameters: CreateInboxPlacementTestRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<InboxPlacementTestRunDto>>

exportInboxPlacementTestResults

exportInboxPlacementTestResults(requestParameters: ExportInboxPlacementTestResultsRequest, initOverrides?: RequestInit): Promise<void>
Export one row per placement target, including run-level delivery totals, 0-10 placement scores, and target placement outcome fields. Export inbox placement test results as CSV
Parameters
- requestParameters: ExportInboxPlacementTestResultsRequest
- Optional initOverrides: RequestInit
Returns Promise<void>

exportInboxPlacementTestResultsRaw

exportInboxPlacementTestResultsRaw(requestParameters: ExportInboxPlacementTestResultsRequest, initOverrides?: RequestInit): Promise<ApiResponse<void>>
Export one row per placement target, including run-level delivery totals, 0-10 placement scores, and target placement outcome fields. Export inbox placement test results as CSV
Parameters
- requestParameters: ExportInboxPlacementTestResultsRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>

getInboxPlacementAnalyticsBreakdown

getInboxPlacementAnalyticsBreakdown(requestParameters: GetInboxPlacementAnalyticsBreakdownRequest, initOverrides?: RequestInit): Promise<InboxPlacementAnalyticsBreakdownDto>
Return aggregated folder, provider, sender-domain, and from-email breakdowns for inbox placement runs in a time range. Get inbox placement analytics breakdowns
Parameters
- requestParameters: GetInboxPlacementAnalyticsBreakdownRequest
- Optional initOverrides: RequestInit
Returns Promise<InboxPlacementAnalyticsBreakdownDto>

getInboxPlacementAnalyticsBreakdownRaw

getInboxPlacementAnalyticsBreakdownRaw(requestParameters: GetInboxPlacementAnalyticsBreakdownRequest, initOverrides?: RequestInit): Promise<ApiResponse<InboxPlacementAnalyticsBreakdownDto>>
Return aggregated folder, provider, sender-domain, and from-email breakdowns for inbox placement runs in a time range. Get inbox placement analytics breakdowns
Parameters
- requestParameters: GetInboxPlacementAnalyticsBreakdownRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<InboxPlacementAnalyticsBreakdownDto>>

getInboxPlacementAnalyticsSeries

getInboxPlacementAnalyticsSeries(requestParameters: GetInboxPlacementAnalyticsSeriesRequest, initOverrides?: RequestInit): Promise<InboxPlacementAnalyticsSeriesDto>
Return chart-ready inbox placement metrics over time, with optional sender/domain filters and grouped comparisons for sender domains or from-email addresses. Get inbox placement analytics time series
Parameters
- requestParameters: GetInboxPlacementAnalyticsSeriesRequest
- Optional initOverrides: RequestInit
Returns Promise<InboxPlacementAnalyticsSeriesDto>

getInboxPlacementAnalyticsSeriesRaw

getInboxPlacementAnalyticsSeriesRaw(requestParameters: GetInboxPlacementAnalyticsSeriesRequest, initOverrides?: RequestInit): Promise<ApiResponse<InboxPlacementAnalyticsSeriesDto>>
Return chart-ready inbox placement metrics over time, with optional sender/domain filters and grouped comparisons for sender domains or from-email addresses. Get inbox placement analytics time series
Parameters
- requestParameters: GetInboxPlacementAnalyticsSeriesRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<InboxPlacementAnalyticsSeriesDto>>

getInboxPlacementPublicShare

getInboxPlacementPublicShare(requestParameters: GetInboxPlacementPublicShareRequest, initOverrides?: RequestInit): Promise<InboxPlacementPublicShareDto>
Get a public inbox placement share
Parameters
- requestParameters: GetInboxPlacementPublicShareRequest
- Optional initOverrides: RequestInit
Returns Promise<InboxPlacementPublicShareDto>

getInboxPlacementPublicShareAnalysis

getInboxPlacementPublicShareAnalysis(requestParameters: GetInboxPlacementPublicShareAnalysisRequest, initOverrides?: RequestInit): Promise<InboxPlacementAnalysisBundleDto>
Get public inbox placement share analysis
Parameters
- requestParameters: GetInboxPlacementPublicShareAnalysisRequest
- Optional initOverrides: RequestInit
Returns Promise<InboxPlacementAnalysisBundleDto>

getInboxPlacementPublicShareAnalysisRaw

getInboxPlacementPublicShareAnalysisRaw(requestParameters: GetInboxPlacementPublicShareAnalysisRequest, initOverrides?: RequestInit): Promise<ApiResponse<InboxPlacementAnalysisBundleDto>>
Get public inbox placement share analysis
Parameters
- requestParameters: GetInboxPlacementPublicShareAnalysisRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<InboxPlacementAnalysisBundleDto>>

getInboxPlacementPublicShareRaw

getInboxPlacementPublicShareRaw(requestParameters: GetInboxPlacementPublicShareRequest, initOverrides?: RequestInit): Promise<ApiResponse<InboxPlacementPublicShareDto>>
Get a public inbox placement share
Parameters
- requestParameters: GetInboxPlacementPublicShareRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<InboxPlacementPublicShareDto>>

getInboxPlacementTest

getInboxPlacementTest(requestParameters: GetInboxPlacementTestRequest, initOverrides?: RequestInit): Promise<InboxPlacementTestRunDto>
Get inbox placement test run
Parameters
- requestParameters: GetInboxPlacementTestRequest
- Optional initOverrides: RequestInit
Returns Promise<InboxPlacementTestRunDto>

getInboxPlacementTestAnalysis

getInboxPlacementTestAnalysis(requestParameters: GetInboxPlacementTestAnalysisRequest, initOverrides?: RequestInit): Promise<InboxPlacementAnalysisBundleDto>
Get inbox placement run analysis
Parameters
- requestParameters: GetInboxPlacementTestAnalysisRequest
- Optional initOverrides: RequestInit
Returns Promise<InboxPlacementAnalysisBundleDto>

getInboxPlacementTestAnalysisRaw

getInboxPlacementTestAnalysisRaw(requestParameters: GetInboxPlacementTestAnalysisRequest, initOverrides?: RequestInit): Promise<ApiResponse<InboxPlacementAnalysisBundleDto>>
Get inbox placement run analysis
Parameters
- requestParameters: GetInboxPlacementTestAnalysisRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<InboxPlacementAnalysisBundleDto>>

getInboxPlacementTestRaw

getInboxPlacementTestRaw(requestParameters: GetInboxPlacementTestRequest, initOverrides?: RequestInit): Promise<ApiResponse<InboxPlacementTestRunDto>>
Get inbox placement test run
Parameters
- requestParameters: GetInboxPlacementTestRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<InboxPlacementTestRunDto>>

getInboxPlacementTestResults

getInboxPlacementTestResults(requestParameters: GetInboxPlacementTestResultsRequest, initOverrides?: RequestInit): Promise<InboxPlacementTestResultsDto>
Get inbox placement test results
Parameters
- requestParameters: GetInboxPlacementTestResultsRequest
- Optional initOverrides: RequestInit
Returns Promise<InboxPlacementTestResultsDto>

getInboxPlacementTestResultsRaw

getInboxPlacementTestResultsRaw(requestParameters: GetInboxPlacementTestResultsRequest, initOverrides?: RequestInit): Promise<ApiResponse<InboxPlacementTestResultsDto>>
Get inbox placement test results
Parameters
- requestParameters: GetInboxPlacementTestResultsRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<InboxPlacementTestResultsDto>>

getInboxPlacementTests

getInboxPlacementTests(requestParameters: GetInboxPlacementTestsRequest, initOverrides?: RequestInit): Promise<InboxPlacementTestRunDto[]>
List inbox placement test runs
Parameters
- requestParameters: GetInboxPlacementTestsRequest
- Optional initOverrides: RequestInit
Returns Promise<InboxPlacementTestRunDto[]>

getInboxPlacementTestsRaw

getInboxPlacementTestsRaw(requestParameters: GetInboxPlacementTestsRequest, initOverrides?: RequestInit): Promise<ApiResponse<InboxPlacementTestRunDto[]>>
List inbox placement test runs
Parameters
- requestParameters: GetInboxPlacementTestsRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<InboxPlacementTestRunDto[]>>

`Protected` request

request(context: RequestOpts, initOverrides?: RequestInit): Promise<Response>
Parameters
- context: RequestOpts
- Optional initOverrides: RequestInit
Returns Promise<Response>

Inherited from BaseAPI.request

withMiddleware

withMiddleware<T>(this: T, ...middlewares: Middleware[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...middlewares: Middleware[]
Returns T

Inherited from BaseAPI.withMiddleware

withPostMiddleware

withPostMiddleware<T>(this: T, ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]
Returns T

Inherited from BaseAPI.withPostMiddleware

withPreMiddleware

withPreMiddleware<T>(this: T, ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]
Returns T

Inherited from BaseAPI.withPreMiddleware

Class ApiInboxPlacementTestControllerApi

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

configuration: Configuration = ...

Returns ApiInboxPlacementTestControllerApi

Properties

Protected configuration

Methods

createInboxPlacementTest

Parameters

requestParameters: CreateInboxPlacementTestRequest

Optional initOverrides: RequestInit

Returns Promise<InboxPlacementTestRunDto>

createInboxPlacementTestRaw

Parameters

requestParameters: CreateInboxPlacementTestRequest

Optional initOverrides: RequestInit

Returns Promise<ApiResponse<InboxPlacementTestRunDto>>

exportInboxPlacementTestResults

Parameters

requestParameters: ExportInboxPlacementTestResultsRequest

Optional initOverrides: RequestInit

Returns Promise<void>

exportInboxPlacementTestResultsRaw

Parameters

requestParameters: ExportInboxPlacementTestResultsRequest

Optional initOverrides: RequestInit

Returns Promise<ApiResponse<void>>

getInboxPlacementAnalyticsBreakdown

Parameters

requestParameters: GetInboxPlacementAnalyticsBreakdownRequest

Optional initOverrides: RequestInit

Returns Promise<InboxPlacementAnalyticsBreakdownDto>

getInboxPlacementAnalyticsBreakdownRaw

Parameters

requestParameters: GetInboxPlacementAnalyticsBreakdownRequest

Optional initOverrides: RequestInit

Returns Promise<ApiResponse<InboxPlacementAnalyticsBreakdownDto>>

getInboxPlacementAnalyticsSeries

Parameters

requestParameters: GetInboxPlacementAnalyticsSeriesRequest

Optional initOverrides: RequestInit

Returns Promise<InboxPlacementAnalyticsSeriesDto>

getInboxPlacementAnalyticsSeriesRaw

Parameters

requestParameters: GetInboxPlacementAnalyticsSeriesRequest

Optional initOverrides: RequestInit

Returns Promise<ApiResponse<InboxPlacementAnalyticsSeriesDto>>

getInboxPlacementPublicShare

Parameters

requestParameters: GetInboxPlacementPublicShareRequest

Optional initOverrides: RequestInit

Returns Promise<InboxPlacementPublicShareDto>

getInboxPlacementPublicShareAnalysis

Parameters

requestParameters: GetInboxPlacementPublicShareAnalysisRequest

Optional initOverrides: RequestInit

Returns Promise<InboxPlacementAnalysisBundleDto>

getInboxPlacementPublicShareAnalysisRaw

Parameters

requestParameters: GetInboxPlacementPublicShareAnalysisRequest

Optional initOverrides: RequestInit

Returns Promise<ApiResponse<InboxPlacementAnalysisBundleDto>>

getInboxPlacementPublicShareRaw

Parameters

requestParameters: GetInboxPlacementPublicShareRequest

Optional initOverrides: RequestInit

Returns Promise<ApiResponse<InboxPlacementPublicShareDto>>

getInboxPlacementTest

Parameters

requestParameters: GetInboxPlacementTestRequest

Optional initOverrides: RequestInit

Returns Promise<InboxPlacementTestRunDto>

getInboxPlacementTestAnalysis

`Protected` configuration

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Protected` request

`Optional` initOverrides: RequestInit

`Rest` ...middlewares: Middleware[]

`Rest` ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]

`Rest` ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]