Get messages on a feature

Description

Retrieves all messages that satisfy the specified criteria.

Endpoint

/path/{pathId}vector/timestamp/{timestampId}/feature/message

Method

GET

Access Level Rules

Minimum Access Level

view+

Processing Units

Minimum processing units

20

Parameters

NameDescriptionRequiredDefault

pathId

The id of the vector layer.

timestampId

The id of the 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 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 messages for.

false

Default null.

userId

The id of the user to get messages for.

false

Default null.

deleted

Boolean specfiying whether deleted messages should be returned instead.

false

Default false.

tiles

Array of objects with required property tileId being an object with the tileX, tileY and zoom of the tile for which to retrieve the messages

false

Default null.

bounds

An object with required properties 'xMin', 'xMax', 'yMin' and 'yMax' denotating the longitude and latitude bounds of the messages to retrieve.

false

Default null.

Last updated