Get Analytics Reports

This endpoint is used to retrive filtered analytics reports based on report type, date range, and optional grouping/filtering criteria.

Note: This API requires an active Analytics Subscription Plan.

SecuritybearerAuth

Request

query Parameters

reportType required	string Type of report to retrieve. Enum: "sending" "shipment"
startDate required	string Start date in YYYYMMDD format.
endDate required	string End date in YYYYMMDD format.
pageNumber	integer Page number for paginated results.
pageSize	integer Number of records per page.

Request Body schema: application/json

limit	integer Maximum number of records to return per page.
offset required	integer Offset value used for pagination.
kpi required	string Specifies the report detail level. Enum: "SUMMARY" "DETAILS" "OVERALL_SPEND_SUMMARYDETAILS"
required	Array of objects Global filters applied to the report query. Each filter must include a `member` and `operator`, and either a single `value` (for scalar filtering) or a list of `values` (for multi-value filtering),depending on the operator used.
	Array of objects Grouping defines how to group the report data based on specific fields. It enables data segmentation and aggregation by categories such as cost account, location, or carrier. Each object specifies the grouping field and the filter condition applied to it.
required	Array of objects Specifies how the data should be grouped and sorted in the final report output. Each object in the array defines a set of columns to group the results by and the columns to use for ordering the grouped data.
measures required	Array of strings List of metrics/columns which will be showcase in the report.

Responses

200

The analytics report based on filters has been generated successfully

400

Invalid request.

401

The request could not be authorized.

500

The request could not be completed due to an internal error.

post/api/v1/reports

Request samples

application/json

{"limit": 10,
"offset": 100,
"kpi": "DETAILS",
"globalFilters": [{"member": "subId",
"operator": "equals",
"value": "2196"
},
{"member": "enterpriseId",
"operator": "equals",
"value": "8409"
},
{"member": "divisionIds",
"operator": "equals",
"values": ["div_CSD1",
"div_SPE",
"div_SPO"
]
},
{"member": "productIds",
"operator": "equals",
"values": [ ]
},
{"member": "psdPcns",
"operator": "equals",
"values": [ ]
},
{"member": "productDisplayName",
"operator": "equals",
"value": "PS - 5466"
},
{"member": "spendType",
"operator": "equals",
"values": ["mailing",
"shipping",
"manual transaction"
]
}
],
"grouping": [{"member": "cost_account_id",
"operator": "equals",
"values": [ ]
}
],
"criteria": [{"groupByColumns": ["location_city",
"location_state",
"lref_location_id",
"product_id"
],
"orderByColumns": ["location_city",
"location_state",
"lref_location_id",
"product_id"
]
}
],
"measures": ["piece_count",
"postage_spend",
"postage_saving",
"avg_spend",
"last_transaction_date",
"base_rate",
"fee_amount",
"surcharges_amount",
"mailing_piece_count",
"shipping_piece_count",
"transaction_end_time",
"transaction_start_time",
"display_cost_account_code",
"display_cost_account_name",
"cost_account_path",
"l1_account_code",
"l1_account_name",
"l2_account_code",
"l2_account_name",
"l3_account_code",
"l3_account_name",
"street1",
"street2",
"country",
"country_code",
"item_type",
"refund_amount",
"refund_piece_count",
"meter_nickname",
"total_with_savings",
"total_with_surcharges",
"total_chargeback_ammount",
"total_add_spl_chrgs_fee",
"display_add_spl_sur_chrgs_name",
"add_spl_chrgs_name",
"address_line_1",
"company_name",
"location_name",
"adjustment_amount",
"bpn",
"total_weight",
"lref_location_id",
"product_id",
"product_display_name"
]
}

Response samples

application/json

[{"errorCode": "validation_error",
"errorDescription": "Error while getting rates for carrier with carrierAccount eRMnRx4mzPP.",
"additionalCode": "string",
"additionalInfo": "string",
"additionalParameters": ["string"
]
}
]