Attributes

The response will be encapsulated by two objects: the data object that will contain the information for the competitors and their listings. And the filters object that will contain the information about the pagination and the results from the filtering process.

Data Object

Within this object each competitor will have the following attributes:

id uuid
The unique id for the competitor.

name string
The name of the competitor set by the user upon it's creation.

listings array
An array with one entry per channel the company has active for competitors, described below.

Listings Array

Within this array each channel will have the following attributes:

channel_id uuid
The unique id for the channel.

channel_name string
The name of the channel populated by Reva.

connected boolean
A boolean indicating if the competitor has a listing connected in the channel.

listing_id uuid
The unique id for the listing. If the competitor is not connected in the channel the returned value will be null.

listing_url string
The URL of the listing in the channel. If the competitor is not connected in the channel the returned value will be null.

Filters Object

Within this object the following attributes will be returned:

total_records integer
The total number of records that match the filters.

per_page integer
The number of records returned per page.

page integer
The current page.

pages integer
The total number of pages with data.