Overview
Architecture
Getting started
API reference
Observability
Contributing
curl --request POST \
--url https://localhost:44371/api/adm/backgroundProcesses \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"type": "BackgroundProcessType.ExportReport",
"priority": "BackgroundProcessPriority.High",
"data": {
"ExportReportParameters": {
"UserEmail": "[email protected]",
"Url": "/reports/transactions"
}
}
}
'{
"success": true,
"code": 200,
"errorMessage": null
}Create Background Process
Creates and initiates a new background process for executing long-running operations such as imports or batch jobs.
curl --request POST \
--url https://localhost:44371/api/adm/backgroundProcesses \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"type": "BackgroundProcessType.ExportReport",
"priority": "BackgroundProcessPriority.High",
"data": {
"ExportReportParameters": {
"UserEmail": "[email protected]",
"Url": "/reports/transactions"
}
}
}
'{
"success": true,
"code": 200,
"errorMessage": null
}Description
Initiates a new background process that will execute asynchronously. The process is created in Pending status and will transition to Running once picked up by the background worker. Use the returned process ID to monitor progress via the GetEntries endpoint.Input
- Body:
inputModel(BackgroundProcessCreateCommandRequest, required) — Process configuration including:processType(string, required) — Type of process to execute (e.g., ImportTransactions).companyProjectId(guid, optional) — Associated company project identifier.settings(string, optional) — JSON string containing process-specific configuration.
Output
Returns aBackgroundProcessCreateCommandResponse containing the ID of the newly created process.
Example Request
POST /api/admin/backgroundProcesses
Content-Type: application/json
Authorization: Bearer {token}
{
"processType": "ImportTransactions",
"companyProjectId": "7bc94a21-8833-4d2f-a5e1-9f4b2d8c1e7a",
"settings": "{\"filePath\":\"imports/transactions_2025.csv\",\"validateOnly\":false}"
}
Example Response
{
"success": true,
"code": 200,
"errorMessage": null,
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
Errors
- 400 Bad Request — Missing required fields, invalid process configuration, or malformed settings JSON.
- 404 Not Found — Referenced company or project does not exist.
- 500 Internal Server Error — Unsupported process type specified.
Notes
- The process starts in Pending status and transitions to Running automatically.
- Use the returned ID to monitor process status via the GetEntries endpoint.
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Body
The command request specifying the process type, configuration, and execution parameters.
Represents the payload required to queue a new background process entry.
Type of background process to create.
AccountUpdaterUploadFile, AccountUpdaterDownloadFile, DownloadChargebackReport, ProcessImportBatches, ReportDataSync, CompanyProjectKeysRegenerate, ServiceIndexes, DownloadPurchaseRefundReport, ExportReport, CompanyAccessKeyExpiration, CreateTransactionsFromChargebacks "BackgroundProcessType.ExportReport"
Priority assigned to the background process.
Normal, High "BackgroundProcessPriority.High"
Payload data supplied to the background process.
Show child attributes
Show child attributes
Parameters for executing the credit card updater workflow.
{
"ProjectId": "f0e352f7-4e5b-46e1-a2e3-4c33805ea3f3",
"CheckedDays": 30
}Parameters for processing staged import batches.
Show child attributes
Show child attributes
Identifier of the company that owns the import batches.
Identifier of the company project containing the import batches.
Type of import batches to process.
Transactions, PaymentsInfo, TransferTransactions, TransferPaymentsInfo Optional maximum number of files to process.
{
"CompanyId": "5f06ba0e-96ae-4385-a9e2-51d58f32631b",
"CompanyProjectId": "422a995f-6050-40be-9e36-1ad8df3c8f5c",
"Type": "TransferTransactions"
}Parameters for chargeback report downloads.
{
"ProjectId": "822a4c1c-64c9-4306-8e02-2d3c839f72a8",
"CheckedDays": 7
}Parameters for purchase refund report downloads.
{
"ProjectId": "9a0cab4d-d78f-4cef-bf07-02d843dc02d2",
"CheckedDays": 14
}Service index database the job should target.
All, ChargeworxDb, ChargeworxCCDb, ReportingDb, ChargeworxKeyDb "DatabaseServiceType.Reports"
Parameters for transactional export report generation.
Show child attributes
Show child attributes
Email address where the export completion notification should be sent.
1Source URL describing the report context for auditing purposes.
1Collection of column definitions included in the exported report.
Show child attributes
Show child attributes
Human-readable heading displayed for the column.
Path or identifier of the underlying transaction property.
Indicates whether the column should render transaction tag values instead of core fields.
Detailed report query definition when exporting a saved report.
Show child attributes
Show child attributes
Identifier of the company that owns the report data. Ensures the report query is executed within the authenticated tenant's boundaries.
1Inclusive start date for the report window. Used to constrain the aggregation to transactions that occurred on or after the specified timestamp.
1Inclusive end date for the report window. Marks the final timestamp that should be included when assembling grouped metrics.
1Threshold that determines when pagination should be bypassed. If the total matches are less than or equal to this value the API returns the entire dataset instead of trimming with Offset and Limit.
Number of grouped rows to skip when paging. Used alongside Limit to support cursor-based navigation in the admin data grid.
Maximum number of grouped rows to return. Sets the page size; common values mirror the UI page length so exports remain manageable.
Collection of field and tag filters applied to the report. Contains the exact filter selections made by the requester, including date, status, and custom tag criteria.
Show child attributes
Show child attributes
Filters applied to custom tag labels. Allows the report to include only transactions tagged with specific values such as campaign or segment names.
Show child attributes
Show child attributes
Tag label being filtered. Should match a tag label defined within the reporting configuration to produce results.
Filter condition applied to the tag. Specifies both the comparison operator and target value for the selected tag label.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to calendar week numbers. Accepts numeric week values (1-53) to restrict the dataset to selected weeks of the year.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to calendar month numbers. Helps isolate activity from specific months within the reporting range.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to transaction result codes. Enables administrators to focus on outcomes such as accepted, declined, or error states.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Undefined, ChargeworxAcceptedProcessorAccepted, ChargeworxDeclinedProcessorAccepted, ChargeworxDeclinedProcessorRejected, Exception Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to transaction event types. Restricts aggregation to lifecycle events like settlements, refunds, or chargebacks.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Authorize, Captured, CreditCaptured, CreditAuthorize, AuthorizeReverse, PreAuthorize, ChargeBackCredit, ChargeBackDebit, ChargebackInquiry Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to transaction event outcomes. Allows narrowing results to events that completed successfully or ended in failure.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Pending, Accepted, Rejected Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to the calendar week of the event timestamp. Useful for focusing on events that occurred during specific weeks regardless of transaction date.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to the calendar month of the event timestamp. Narrows results to events that occurred during specified months.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to CVV validation results. Supports investigations that focus on transactions where CVV passed or failed.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to credit card types. Enables filtering datasets to a specific card network such as Visa or MasterCard.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
VISA, MasterCard, AmericanExpress, Discover Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to project names. Allows administrators to limit grouped results to selected projects managed by the tenant.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to full transaction timestamps. Accepts values formatted as MM/dd/yyyy hh:mm tt zzz to constrain the dataset by exact timestamp ranges.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to the time-of-day component of the transaction timestamp. Uses the format hh:mm:ss tt zzz to isolate results within specific hours across all dates.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to the transaction calendar date component. Requires the format MM/dd/yyyy to limit the report to particular days.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to the transaction calendar year component. Allows comparisons across multiple years by restricting the dataset to a specific year string.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to full event timestamps. Accepts values formatted as MM/dd/yyyy hh:mm tt zzz, focusing on when events occurred in the processing pipeline.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to the time-of-day component of event timestamps. Uses the format hh:mm:ss tt zzz to focus on events that occurred within specified hours.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to the calendar date component of event timestamps. Requires the format MM/dd/yyyy to target events falling on particular days.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to the calendar year component of event timestamps. Enables year-based filtering using the string representation returned by the reporting API.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to client IP addresses. Useful for isolating traffic from particular networks or blocking suspicious sources.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to device fingerprint values. Helps detect repeated device usage across multiple transactions.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to payer email addresses. Enables donor or customer-level filtering for exports and dashboards.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to credit card last four digits. Supports targeted analysis of activity tied to a specific card suffix.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to credit card expiration dates. Uses the MM/YY format to identify cards expiring within the selected range.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to billing first names. Allows name-based searching within aggregated results.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to billing last names. Complements the first-name filter to match full billing names.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to billing address line 1. Supports identification of transactions coming from specific street addresses.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to billing address line 2. Captures detailed unit-level filtering for billing addresses.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to billing cities. Allows geographic filtering by municipality.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to billing states or provinces. Accepts postal abbreviations to focus on specific regions.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to billing postal codes. Enables detailed geographic segmentation by ZIP or postal code.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to billing countries. Useful for tenants operating across multiple countries.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to delivery recipient first names. Helps isolate shipments based on recipient details.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to delivery recipient last names. Complements the first-name filter for recipient-level searches.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to delivery address line 1. Supports logistics reviews targeting specific delivery routes.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to delivery address line 2. Enables unit-level filtering for shipping addresses.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to delivery cities. Enables shipment reporting targeted at specific municipalities.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to delivery states or provinces. Accepts postal abbreviations to focus on particular destinations.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to delivery postal codes. Supports granular segmentation of outgoing shipments by ZIP code.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to delivery countries. Allows exports to focus on international or domestic destinations as needed.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Sort instructions for the grouped results. Defines which columns should dictate ordering when the response is presented in tables or exported files.
Show child attributes
Show child attributes
Ordering configuration for tag-based dimensions. Determines how grouped rows are sorted when tag values are included in the report definition.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Tag label being sorted. Should reference an existing tag definition to ensure the order-by clause resolves correctly.
Ordering configuration for Project Name. Controls how aggregated rows are sorted when prioritizing the Project Name dimension.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Date Time. Controls how aggregated rows are sorted when prioritizing the Date Time dimension.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Time. Controls how aggregated rows are sorted when prioritizing the Time dimension.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Date. Controls how aggregated rows are sorted when prioritizing the Date dimension.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Week. Controls how aggregated rows are sorted when prioritizing the Week dimension.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Month. Controls how aggregated rows are sorted when prioritizing the Month dimension.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Year. Controls how aggregated rows are sorted when prioritizing the Year dimension.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Result Code. Controls how aggregated rows are sorted when prioritizing the Result Code dimension.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Event Type. Controls how aggregated rows are sorted when prioritizing the Event Type dimension.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Event Result. Controls how aggregated rows are sorted when prioritizing the Event Result dimension.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Event Date Time. Controls how aggregated rows are sorted when prioritizing the Event Date Time dimension.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Event Time. Controls how aggregated rows are sorted when prioritizing the Event Time dimension.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Event Date. Controls how aggregated rows are sorted when prioritizing the Event Date dimension.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Event Week. Controls how aggregated rows are sorted when prioritizing the Event Week dimension.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Event Month. Controls how aggregated rows are sorted when prioritizing the Event Month dimension.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Event Year. Controls how aggregated rows are sorted when prioritizing the Event Year dimension.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for IP Address. Controls how aggregated rows are sorted when prioritizing the IP Address dimension.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Fingerprint. Controls how aggregated rows are sorted when prioritizing the Fingerprint dimension.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for CVV Status. Controls how aggregated rows are sorted when prioritizing the CVV Status dimension.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Billing First Name. Controls how aggregated rows are sorted when prioritizing the Billing First Name dimension.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Billing Last Name. Controls how aggregated rows are sorted when prioritizing the Billing Last Name dimension.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Email. Controls how aggregated rows are sorted when prioritizing the Email dimension.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Credit Card Type. Controls how aggregated rows are sorted when prioritizing the Credit Card Type dimension.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Credit Card Last 4. Controls how aggregated rows are sorted when prioritizing the Credit Card Last 4 dimension.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Credit Card Expiration Date. Controls how aggregated rows are sorted when prioritizing the Credit Card Expiration Date dimension.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Billing Address Line 1. Controls how aggregated rows are sorted when prioritizing the Billing Address Line 1 dimension.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Billing Address Line 2. Controls how aggregated rows are sorted when prioritizing the Billing Address Line 2 dimension.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Billing City. Controls how aggregated rows are sorted when prioritizing the Billing City dimension.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Billing State. Controls how aggregated rows are sorted when prioritizing the Billing State dimension.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Billing Zip. Controls how aggregated rows are sorted when prioritizing the Billing Zip dimension.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Billing Country. Controls how aggregated rows are sorted when prioritizing the Billing Country dimension.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Delivery First Name. Controls how aggregated rows are sorted when prioritizing the Delivery First Name dimension.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Delivery Last Name. Controls how aggregated rows are sorted when prioritizing the Delivery Last Name dimension.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Delivery Address Line 1. Controls how aggregated rows are sorted when prioritizing the Delivery Address Line 1 dimension.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Delivery Address Line 2. Controls how aggregated rows are sorted when prioritizing the Delivery Address Line 2 dimension.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Delivery City. Controls how aggregated rows are sorted when prioritizing the Delivery City dimension.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Delivery State. Controls how aggregated rows are sorted when prioritizing the Delivery State dimension.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Delivery Zip. Controls how aggregated rows are sorted when prioritizing the Delivery Zip dimension.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Delivery Country. Controls how aggregated rows are sorted when prioritizing the Delivery Country dimension.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Payment Authorizations Count. Controls how aggregated rows are sorted when prioritizing the Payment Authorizations Count dimension.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Payment Authorizations Value. Controls how aggregated rows are sorted when prioritizing the Payment Authorizations Value dimension.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Payment Settlements Count. Controls how aggregated rows are sorted when prioritizing the Payment Settlements Count dimension.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Payment Settlements Value. Controls how aggregated rows are sorted when prioritizing the Payment Settlements Value dimension.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Refund Authorizations Count. Controls how aggregated rows are sorted when prioritizing the Refund Authorizations Count dimension.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Refund Authorizations Value. Controls how aggregated rows are sorted when prioritizing the Refund Authorizations Value dimension.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Refund Settlements Count. Controls how aggregated rows are sorted when prioritizing the Refund Settlements Count dimension.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Refund Settlements Value. Controls how aggregated rows are sorted when prioritizing the Refund Settlements Value dimension.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Payment Reverse Authorizations Count. Controls how aggregated rows are sorted when prioritizing the Payment Reverse Authorizations Count dimension.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Payment Reverse Authorizations Value. Controls how aggregated rows are sorted when prioritizing the Payment Reverse Authorizations Value dimension.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Chargebacks Count. Controls how aggregated rows are sorted when prioritizing the Chargebacks Count dimension.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Chargebacks Value. Controls how aggregated rows are sorted when prioritizing the Chargebacks Value dimension.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Amount. Controls how aggregated rows are sorted when prioritizing the Amount dimension.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for First Event Date. Controls how aggregated rows are sorted when prioritizing the First Event Date dimension.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Last Event Date. Controls how aggregated rows are sorted when prioritizing the Last Event Date dimension.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for First Event Date Time. Controls how aggregated rows are sorted when prioritizing the First Event Date Time dimension.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Last Event Date Time. Controls how aggregated rows are sorted when prioritizing the Last Event Date Time dimension.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Event Count. Controls how aggregated rows are sorted when prioritizing the Event Count dimension.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Last Event Type. Controls how aggregated rows are sorted when prioritizing the Last Event Type dimension.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Last Event Result. Controls how aggregated rows are sorted when prioritizing the Last Event Result dimension.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Grouping configuration describing how transactions should be aggregated. Allows combinations of project, tag, and date-based groupings to be expressed in a single report definition.
Show child attributes
Show child attributes
Tag-based grouping selections applied to the report. Allows administrators to aggregate transactions by custom metadata such as campaign or region.
Show child attributes
Show child attributes
Zero-based position of the grouping dimension. Determines the sequence applied when constructing group-by clauses for report queries.
Tag label used for grouping. Must match the custom tag name defined in the reporting schema to successfully aggregate values.
Grouping configuration for project names. When populated, aggregated rows are separated per project before metrics are calculated.
Show child attributes
Show child attributes
Zero-based position of the grouping dimension. Determines the sequence applied when constructing group-by clauses for report queries.
Grouping configuration for the transaction timestamp. Enables time-series rollups at the granularity selected in the UI.
Show child attributes
Show child attributes
Zero-based position of the grouping dimension. Determines the sequence applied when constructing group-by clauses for report queries.
Grouping configuration for the time-of-day component. Useful when administrators want to analyze intraday performance regardless of date.
Show child attributes
Show child attributes
Zero-based position of the grouping dimension. Determines the sequence applied when constructing group-by clauses for report queries.
Grouping configuration for the transaction date component. Produces daily aggregation buckets when selected.
Show child attributes
Show child attributes
Zero-based position of the grouping dimension. Determines the sequence applied when constructing group-by clauses for report queries.
Grouping configuration for calendar weeks. Allows transaction summaries to be presented by week number.
Show child attributes
Show child attributes
Zero-based position of the grouping dimension. Determines the sequence applied when constructing group-by clauses for report queries.
Grouping configuration for months. Aggregates transactions by calendar month when requested.
Show child attributes
Show child attributes
Zero-based position of the grouping dimension. Determines the sequence applied when constructing group-by clauses for report queries.
Grouping configuration for calendar years. Enables multi-year comparisons in exported datasets.
Show child attributes
Show child attributes
Zero-based position of the grouping dimension. Determines the sequence applied when constructing group-by clauses for report queries.
Grouping configuration for transaction result codes. Splits aggregations by success, decline, or error outcomes.
Show child attributes
Show child attributes
Zero-based position of the grouping dimension. Determines the sequence applied when constructing group-by clauses for report queries.
Grouping configuration for event types. Separates results by lifecycle events such as authorizations, settlements, or refunds.
Show child attributes
Show child attributes
Zero-based position of the grouping dimension. Determines the sequence applied when constructing group-by clauses for report queries.
Grouping configuration for event results. Allows aggregations to be broken out by success, failure, or pending outcomes.
Show child attributes
Show child attributes
Zero-based position of the grouping dimension. Determines the sequence applied when constructing group-by clauses for report queries.
Grouping configuration for event timestamps. Enables time-series analysis based on when events occurred rather than the originating transaction time.
Show child attributes
Show child attributes
Zero-based position of the grouping dimension. Determines the sequence applied when constructing group-by clauses for report queries.
Grouping configuration for the time-of-day component of events. Supports intraday comparisons for event activity.
Show child attributes
Show child attributes
Zero-based position of the grouping dimension. Determines the sequence applied when constructing group-by clauses for report queries.
Grouping configuration for the date component of events. Produces daily rollups based on event occurrence.
Show child attributes
Show child attributes
Zero-based position of the grouping dimension. Determines the sequence applied when constructing group-by clauses for report queries.
Grouping configuration for event calendar weeks. Summarizes event activity by week number.
Show child attributes
Show child attributes
Zero-based position of the grouping dimension. Determines the sequence applied when constructing group-by clauses for report queries.
Grouping configuration for event calendar months. Aggregates event activity by month within the reporting window.
Show child attributes
Show child attributes
Zero-based position of the grouping dimension. Determines the sequence applied when constructing group-by clauses for report queries.
Grouping configuration for event calendar years. Supports year-over-year comparisons focused on event timing.
Show child attributes
Show child attributes
Zero-based position of the grouping dimension. Determines the sequence applied when constructing group-by clauses for report queries.
Grouping configuration for client IP addresses. Enables network-level segmentation when analysing fraud trends.
Show child attributes
Show child attributes
Zero-based position of the grouping dimension. Determines the sequence applied when constructing group-by clauses for report queries.
Grouping configuration for device fingerprints. Aggregates results by captured device identifiers to surface repeated usage.
Show child attributes
Show child attributes
Zero-based position of the grouping dimension. Determines the sequence applied when constructing group-by clauses for report queries.
Grouping configuration for CVV validation results. Allows reports to separate rows where CVV passed, failed, or was skipped.
Show child attributes
Show child attributes
Zero-based position of the grouping dimension. Determines the sequence applied when constructing group-by clauses for report queries.
Grouping configuration for payer email addresses. Enables customer-level aggregations across the reporting window.
Show child attributes
Show child attributes
Zero-based position of the grouping dimension. Determines the sequence applied when constructing group-by clauses for report queries.
Grouping configuration for credit card types. Splits aggregated metrics by card network such as Visa or MasterCard.
Show child attributes
Show child attributes
Zero-based position of the grouping dimension. Determines the sequence applied when constructing group-by clauses for report queries.
Grouping configuration for credit card last four digits. Helps isolate activity tied to a specific card without exposing full numbers.
Show child attributes
Show child attributes
Zero-based position of the grouping dimension. Determines the sequence applied when constructing group-by clauses for report queries.
Grouping configuration for credit card expiration dates. Highlights cards expiring in the same month and year across grouped rows.
Show child attributes
Show child attributes
Zero-based position of the grouping dimension. Determines the sequence applied when constructing group-by clauses for report queries.
Grouping configuration for billing first names. Useful for segmentation when donor or buyer names matter to reporting audiences.
Show child attributes
Show child attributes
Zero-based position of the grouping dimension. Determines the sequence applied when constructing group-by clauses for report queries.
Grouping configuration for billing last names. Complements first-name grouping to deliver full-person drills.
Show child attributes
Show child attributes
Zero-based position of the grouping dimension. Determines the sequence applied when constructing group-by clauses for report queries.
Grouping configuration for the primary billing street address. Enables location-based aggregation down to the street level.
Show child attributes
Show child attributes
Zero-based position of the grouping dimension. Determines the sequence applied when constructing group-by clauses for report queries.
Grouping configuration for the secondary billing street address. Captures suite or unit differentiation when analyzing repeated addresses.
Show child attributes
Show child attributes
Zero-based position of the grouping dimension. Determines the sequence applied when constructing group-by clauses for report queries.
Grouping configuration for billing cities. Aggregates metrics by municipality for regional reporting.
Show child attributes
Show child attributes
Zero-based position of the grouping dimension. Determines the sequence applied when constructing group-by clauses for report queries.
Grouping configuration for billing states or provinces. Supports state-level summaries across the tenant.
Show child attributes
Show child attributes
Zero-based position of the grouping dimension. Determines the sequence applied when constructing group-by clauses for report queries.
Grouping configuration for billing postal codes. Allows detailed geographic segmentation using ZIP or postal codes.
Show child attributes
Show child attributes
Zero-based position of the grouping dimension. Determines the sequence applied when constructing group-by clauses for report queries.
Grouping configuration for billing countries. Useful for multi-country tenants consolidating performance reports.
Show child attributes
Show child attributes
Zero-based position of the grouping dimension. Determines the sequence applied when constructing group-by clauses for report queries.
Grouping configuration for delivery recipient first names. Supports fulfillment analysis when shipping recipients differ from billing contacts.
Show child attributes
Show child attributes
Zero-based position of the grouping dimension. Determines the sequence applied when constructing group-by clauses for report queries.
Grouping configuration for delivery recipient last names. Complements first-name grouping for full recipient segmentation.
Show child attributes
Show child attributes
Zero-based position of the grouping dimension. Determines the sequence applied when constructing group-by clauses for report queries.
Grouping configuration for the primary delivery street address. Helps identify shipment clusters at the address level.
Show child attributes
Show child attributes
Zero-based position of the grouping dimension. Determines the sequence applied when constructing group-by clauses for report queries.
Grouping configuration for the secondary delivery street address. Adds differentiation for units or suites in delivery analysis.
Show child attributes
Show child attributes
Zero-based position of the grouping dimension. Determines the sequence applied when constructing group-by clauses for report queries.
Grouping configuration for delivery cities. Provides geographic segmentation focused on shipment destinations.
Show child attributes
Show child attributes
Zero-based position of the grouping dimension. Determines the sequence applied when constructing group-by clauses for report queries.
Grouping configuration for delivery states or provinces. Supports state-level logistics reporting.
Show child attributes
Show child attributes
Zero-based position of the grouping dimension. Determines the sequence applied when constructing group-by clauses for report queries.
Grouping configuration for delivery postal codes. Enables granular segmentation of shipment destinations by ZIP or postal code.
Show child attributes
Show child attributes
Zero-based position of the grouping dimension. Determines the sequence applied when constructing group-by clauses for report queries.
Grouping configuration for delivery countries. Useful when reporting on international fulfillment activity.
Show child attributes
Show child attributes
Zero-based position of the grouping dimension. Determines the sequence applied when constructing group-by clauses for report queries.
Time zone used to interpret StartDate and EndDate. Defaults to Eastern Standard Time to preserve legacy behavior but can be overridden when exporting for other regions.
Ad-hoc search parameters applied to the export operation.
Show child attributes
Show child attributes
Identifier of the company that owns the search data.
1Inclusive start date for the search window.
1Inclusive end date for the search window.
1Threshold that determines when pagination should be bypassed.
Number of rows to skip when paging.
Maximum number of rows to return.
Collection of field and tag filters applied to the search.
Show child attributes
Show child attributes
Filters applied to custom tag labels.
Show child attributes
Show child attributes
Tag label being filtered. Should match a tag label defined within the reporting configuration to produce results.
Filter condition applied to the tag. Specifies both the comparison operator and target value for the selected tag label.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to transaction identifiers.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to calendar week numbers.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to calendar month numbers.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to event identifiers.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to transaction result codes.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Undefined, ChargeworxAcceptedProcessorAccepted, ChargeworxDeclinedProcessorAccepted, ChargeworxDeclinedProcessorRejected, Exception Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to transaction event types.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Authorize, Captured, CreditCaptured, CreditAuthorize, AuthorizeReverse, PreAuthorize, ChargeBackCredit, ChargeBackDebit, ChargebackInquiry Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to transaction event outcomes.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Pending, Accepted, Rejected Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to the calendar week of the event timestamp.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to the calendar month of the event timestamp.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to CVV validation results.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to credit card types.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
VISA, MasterCard, AmericanExpress, Discover Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to project names.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to full transaction timestamps. Allowed format: MM/dd/yyyy hh:mm tt zzz
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to the time-of-day component of the transaction timestamp. Allowed format: hh:mm:ss tt zzz
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to the transaction calendar date component. Allowed format: MM/dd/yyyy
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to the transaction calendar year component.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to full event timestamps. Allowed format: MM/dd/yyyy hh:mm tt zzz
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to the time-of-day component of event timestamps. Allowed format: hh:mm:ss tt zzz
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to the calendar date component of event timestamps. Allowed format: MM/dd/yyyy
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to the calendar year component of event timestamps.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to client IP addresses.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to device fingerprint values.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to payer email addresses.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to credit card last four digits.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to credit card expiration dates.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to billing first names.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to billing last names.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to billing address line 1.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to billing address line 2.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to billing cities.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to billing states or provinces.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to billing postal codes.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to billing countries.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to delivery recipient first names.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to delivery recipient last names.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to delivery address line 1.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to delivery address line 2.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to delivery cities.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to delivery states or provinces.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to delivery postal codes.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Filters applied to delivery countries.
Show child attributes
Show child attributes
Value to compare against the target field. Serialized according to the target field type—for example, ISO timestamps for date comparisons or decimals for numeric totals.
Operator used when evaluating the filter. Accepts enumeration members from ReportFilterCondition that are compatible with the field type.
Equals, Contains, Less, LessOrEqual, Greater, GreaterOrEqual Sort instructions for the search results.
Show child attributes
Show child attributes
Ordering configuration for tag-based dimensions.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Tag label being sorted. Should reference an existing tag definition to ensure the order-by clause resolves correctly.
Ordering configuration for Project Name.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Transaction ID.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Date Time.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Time.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Date.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Week.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Month.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Year.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Result Code.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Event ID.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Event Type.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Event Result.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Event Date Time.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Event Time.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Event Date.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Event Week.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Event Month.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Event Year.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for IP Address.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Fingerprint.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for CVV Status.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Billing First Name.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Billing Last Name.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Email.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Credit Card Type.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Credit Card Last 4.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Credit Card Expiration Date.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Billing Address Line 1.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Billing Address Line 2.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Billing City.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Billing State.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Billing Zip.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Billing Country.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Delivery First Name.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Delivery Last Name.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Delivery Address Line 1.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Delivery Address Line 2.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Delivery City.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Delivery State.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Delivery Zip.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Ordering configuration for Delivery Country.
Show child attributes
Show child attributes
Zero-based ordering index of the field. Indicates which field should be evaluated first when multiple sort orders are provided.
Sort direction applied to the field. Utilizes ReportOrderOption members to express ascending or descending output.
Asc, Desc Time zone used to interpret StartDate and EndDate. Default value: Eastern Standard Time
{
"UserEmail": "[email protected]",
"Url": "/reports/transactions",
"Columns": [{ "Title": "Amount", "Property": "amount" }]
}{
"ExportReportParameters": {
"UserEmail": "[email protected]",
"Url": "/reports/transactions"
}
}Response
Always returned. Check the success property in the response body to determine if the operation succeeded.
Standard response structure containing operation status and error information. Represents the response returned after a background process command executes.
True if the operation completed successfully; false if an error occurred.
true
Result code indicating the outcome of the operation.
Unknown, Success, BadRequest, Unauthorized, NotFound, Error 200
Human-readable error message when an error occurs.
null