GetOnSiteSendTargetList

get

https://api.dengage.com/rest/logs/onsite/sendTarget

GetOnSiteSendTargetList function gets all reachable contacts about an on site notification send.

Important note: If the client does not have a sendId yet, sendId parameter can be given as 0 to get data from first notification of the sending which is given with the sendId parameter.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

sendId

string

required

uuid of notification send

limit

string

length between 100 and 1000

The requested maximum number of rows from the request.

Maximum value is 1000.

For instance, if lastMessageId is 1500 and limit is 1000, the api returns the rows between 1501-2500.

lastMessageId

string

The lastMessageId is the number of last fetched message id from the api. For instance, if lastMessageId is 1500 and limit is 1000, the api returns the message ids start with between 1501-2501.

returnEmailAddress

boolean

This is an optional parameter. If set, returns the contact email.

Headers

Authorization

string

required

Defaults to {$$.env.access_token}

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

401

Not-authenticated. Please re-login.

429

Too Many Requests

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

TooManyRequest

200

400Bad request. Please check message for detail.

403The operation is not allowed. Your api user is not authorized to use this api.