/async/pollByRange
  • 1 Minute to read
  • Dark
    Light

/async/pollByRange

  • Dark
    Light

Article summary

Get
/async/pollByRange

Retrieves a specific number of results for a topic from the result queue in the designated period.
Request body example:

{
"type":"linkClick",
"from":"1683637275"
"to":"1683720075"
"limit":"86400"
}

Query parameters
type
stringRequired

Type of events customer would like to poll (e.g allMessages [This TYPE consolidates all types below except for sentToMta, therefore 2-10 below are included in allMessages], linkClick, mtaResponse, smsResponse, readTrack, forwardTrack, conversion, skipTracking, sendTransactional, unsubscribe, sentToMta [This type must be called separately. For any customer to get all available types their web-service must be able to make at least two separate calls. 1. To allMessages type, and 2. To sentToMta type])

from
integer (int64) Required

Opening timestamp from when the customer would like to get events (warning: timestamp is a time of inserting event to the database, not time of occurring of the event, so if the event happened at 31st of January at 23:59:59 but we had a delay in inserting and it was inserted of 1st of February then timestamp will be on February).

to
integer (int64) Required

Closing timestamp.

limit
integer (int64) Required

A number of events to fetch.

Responses
200
Array of object
object
400

Was this article helpful?

What's Next