Get messages on a feature
Last updated
Last updated
Description
Retrieves all messages that satisfy the specified criteria.
Endpoint
/path/{pathId}vector/timestamp/{timestampId}/feature/message
Method
GET
Minimum Access Level
view
Minimum processing units
20
pathId
The id of the vector layer.
timestampId
The id of the vector timestamp.
returnType
The type of data to return. Must be one of "count", "id", or "all".
false
Default "all".
pageSize
The maximum number of messages to retrieve. Maximum 100.
false
Default 100.
pageStart
The start of the next page of the messages as a date string.
false
Default null.
messageIds
An array of message ids to retrieve.
false
Default null.
featureIds
An array of geometry ids to get the messages of.
false
Default null.
userId
The id of the user to get messages for.
false
Default null.
deleted
Boolean specifying whether deleted messages should be returned instead.
false
Default false.
tiles
Array of JSONs with required property "tileId" being a JSON with the "tileX", "tileY" and "zoom" of the tile for which to retrieve the messages.
false
Default null.
bounds
A JSON with required properties "xMin", "xMax", "yMin" and "yMax" denoting the longitude and latitude bounds of the messages to retrieve.
false
Default null.