Contents x
    /message/getStatistics
    • 1 Minute to read
    • Print
    • Dark
      Light
    Contents

    /message/getStatistics

    • 1 Minute to read
    • Print
    • Dark
      Light
    Article summary

    The API endpoint `/message/getStatistics` is designed to retrieve statistical data for a specific sent message, identified by its `messageId`, which is a required integer parameter. Upon a successful request, a 200 response returns various details about the message, including its ID, name, subject, external ID, associated group ID and name, group size, and the duration of the sendout process. Additionally, it provides timestamps for the start and end of the sendout and transfer processes, along with their respective durations and progress. The response also includes a `selectionName` and an array of statistical values, each represented as an object containing a name and value. In case of an error, a 400 response is returned. This endpoint is useful for analyzing the performance and metrics of sent messages.

    Get
    /message/getStatistics

    Retrieves statistical data for a sent message.

    Query parameters
    messageId
    integer (int64) Required

    ID of the message

    Responses
    200

    Example response: 

    {
        "messageId": 1800228386,
        "messageName": "Test_Export Campaign Winter Bottom March 2014",
        "messageSubject": "Winter Bottom",
        "externalMessageId": "ExternalWinter",
        "groupId": 1800138893,
        "groupName": "Test_Export",
        "groupSize": 20,
        "sendoutStartDate": 1404721300908,
        "sendoutEndDate": 1404721301837,
        "selectionName": null,
        "statisticValues": [{
            "name": "sentsPerFormat",
            "value": "email-html-multipart=16" }, {
            "name": "uniqueClicker",
            "value": "5" }, {
            "name": "uniqueConfirmedOpener",
            "value": "16" }, {
            "name": "clickRate",
            "value": "31.25" }],
        "senderProfile": "forced"
    }

    Expand All
    object
    messageId
    integer (int64)
    messageName
    string
    messageSubject
    string
    externalMessageId
    string
    groupId
    integer (int64)
    groupName
    string
    groupSize
    integer (int64)
    sendoutStartDate
    integer (int64)
    sendoutEndDate
    integer (int64)
    sendoutDuration
    string
    transferStartDate
    integer (int64)
    transferEndDate
    integer (int64)
    transferDuration
    string
    transferProgress
    string
    selectionName
    string
    statisticValues
    Array of object (Attribute)
    object
    name
    string
    value
    string
    senderProfile
    string
    400
    Was this article helpful?
    What's Next