Retrieve a list of transaction timeline messages

Retrieve a list of transaction timeline messages.

SecuritySecretApiKey or JWT
Request
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

Resource identifier string.

query Parameters
limit
integer [ 0 .. 1000 ]

Limits the number of collection items to be returned.

offset
integer >= 0

Specifies the starting point within the collection of items to be returned.

filter
string

Filters the collection items. This field requires a special format. Use , for multiple allowed values. Use ; for multiple fields.

For more information, see Using filter with collections.

Responses
200

A list of transaction timeline messages was retrieved.

Response Headers
Pagination-Total
integer

Total number of items.

Example: 332
Pagination-Limit
integer

Maximum number of items per page.

Example: 100
Pagination-Offset
integer

Specifies the starting point within the collection of resource results. For example, a request with limit=20 retrieves and displays the first 20 results on a page. A following request with limit=20 and offset=20, retrieves the next page of 20 results.

Example: 2
Response Schema: application/json
Array
id
string <= 50 characters

The Timeline message identifier string.

type
string

Timeline message type.

Enum: "amount-adjusted" "blocklist-matched" "bump-offer-accepted" "bump-offer-presented" "bump-offer-rejected" "customer-redirected-offsite" "customer-returned" "dcc-offer-accepted" "dcc-offer-forced" "dcc-offer-presented" … 40 more
triggeredBy
string

Shows who or what triggered the Timeline message.

Enum: "rebilly" "app" "direct-api"
message
string

The message that describes the message details.

object (TimelineExtraData)

Additional data.

Array of objects (TimelineAction) >= 0 items

Actions available to a Timeline message. Can be empty in case no actions are available for a message.

Array of objects (TimelineTable) >= 0 items
object

Timeline comment author data.

object
Array of objects
occurredTime
string <date-time>

Timeline message time.

Array of objects (Self) non-empty

Related resource links.

Array (non-empty)
href
required
string

Link URL.

rel
required
string

Type of link.

Value: "self"
401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

get/transactions/{id}/timeline
Request samples
// all parameters are optional except for the `id`
const firstCollection = await api.transactions
    .getAllTimelineMessages({id: 'my-transaction'});

// alternatively you can specify one or more of them
const params = {id: 'my-transaction', limit: 20, offset: 100};
const secondCollection = await api.transactions.getAllTimelineMessages(params);

// access the collection items, each item is a Member
secondCollection.items
    .forEach(message => console.log(message.fields.eventType));
Response samples
application/json
[
  • {
    }
]