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

    /message/getTimeDistribution

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

    Post
    /message/getTimeDistribution

    Retrieves statistical time distribution information for a specific sent message.

    Query parameters
    messageId
    integer (int64) Required

    ID of the message

    interval
    stringRequired

    Interval values: DAILY or HOURLY

    Valid values[ "DAILY", "HOURLY" ]
    Responses
    200
    Expand All
    object
    messageId
    integer (int64)
    messageName
    string
    messageSubject
    string
    groupName
    string
    sendout
    integer (int64)
    confirmedOpens
    integer (int64)
    confirmedOpeners
    integer (int64)
    totalClicks
    integer (int64)
    clickers
    integer (int64)
    acceptedMessages
    integer (int64)
    messagesOpened
    integer (int64)
    messagesClicked
    integer (int64)
    timeFrameStart
    integer (int64)
    timeFrameEnd
    integer (int64)
    interval
    string
    Valid values[ "DAILY", "HOURLY" ]
    periods
    Array of object (MessageTimeDistributionPeriod)
    object
    messageId
    integer (int64)
    periodStart
    integer (int64)
    periodEnd
    integer (int64)
    statisticValues
    Array of object (Attribute)
    object
    name
    string
    value
    string
    400

    Missing parameter (messageId) or parameter value, for example:

    {
      "errorActor": "CLIENT",
      "errorCode": "MISSING_PARAMETER",
      "message": "Parameter 'messageId' is mandatory but no value was specified.",
      "parameterName": "messageId",
      "propertyName": null,
      "value": "null"
    }


    Message ID does not exist, for example:

    {
      "errorActor": "CLIENT",
      "errorCode": "NO_SUCH_OBJECT",
      "message": "Message with id=24011454555 does not exist.",
      "objectType": "Message",
      "propertyName": "id",
      "propertyValue": "24011454555"
    }

    Was this article helpful?
    What's Next