ConsumerPagedResponse

Table of contents

1. Description
2. Properties
3. @Example

---

Description

The actual response object received when requesting from the Undelivered and Matched APIs.

Properties

Field	Type	Description
responseMetadata	PageMetadata (object)	Represents page’s metadata, e.g. what is the currently looked page, how many pages there are, etc.
results	ConsumerEvent[] (array	An array of matched/undelivered events

@Example

Note: This is the payload you will receive on response.

const consumerPagedResponse = {
        responseMetadata: {
            page: 0,
            pageSize: 100,
            totalPages: 1,
            totalResultsCount: 1
        },
        results: [
            {
                id: 'matched-or-undelivered-event-id',
                body: 'Your test-resource has been',
                subject: 'test-resource exceeds cpu limits',
                eventType: 'HighCpu',
                severity: 'WARNING',
                category: 'ALERT',
                resource: {
                    resourceName: 'test-resource',
                    resourceType: 'application'
                },
                eventTimestamp: 1602787032,
                metadata: {
                    cacheTime: 1602788032,
                    affectedActionId: 'to-store',
                    deliveryStatus: 'MATCHED'
                }
            }
        ]
};