Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description

Retrieves a specific number of results for a topic from the result queue in the designated period

Available from

v13

Request path

GET [REST URL]/async/pollByRange

Query Parameters

Parameter

Type

Description

type

String

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

Datetime type

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

Datetime type

Closing timestamp.

limit

Integer

A number of events to fetch.

Example bodies

Code Block
{
    "type":"linkClick",
    "from":"2020-04-01"
    "to":"2020-04-17"
    "limit":"10000"
}