[GET] Source Data

Method	Path
`GET`	`https://agora.olery.com/v3/companies/:id/source_data`

This endpoint returns source data like rankings.

Filtering by Dates

The values of this endpoint are captured once every day. Using the since parameter will therefore return the data grouped by days. When no since is specified the default of 1 week is used.

Output Format

The aggregated data is returned as a JSON array in the data field. There is an object for each source.

These are the fields with the source data:

Field	Data Types	Description
date	Date	Day on which the ranking was captured
position	Integer	Position in the ranking (as presented or counted)
properties_count	Integer	Total number of properties in the ranking
location	String	Scope of the ranking
displayed_rating	Float	The central rating as presented on the source

Example Output

    {
      "data": [
        {
          "id": 4,
          "name": "hotel-reviews",
          "friendly_name": "HotelReviews.com",
          "per_day": [
            {
              "date": "2017-02-01",
              "ranking": {
                "position": 91,
                "properties_count": 392,
                "location": "Amsterdam"
              },
              "displayed_rating": 8.4
            },
            {
              "date": "2017-01-31",
              "ranking": {
                "position": 92,
                "properties_count": 395,
                "location": "Amsterdam"
              },
              "displayed_rating": 8.4
            },
            {
              "date": "2017-01-30",
              "ranking": {
                "position": 92,
                "properties_count": 395,
                "location": "Amsterdam"
              },
              "displayed_rating": 8.4
            }
          ]
        },
        {
          "id": 116,
          "name": "review_site",
          "friendly_name": "ReviewSite.com",
          "per_day": [
            {
              "date": "2017-02-01",
              "ranking": {
                "position": 68,
                "properties_count": 361,
                "location": "Amsterdam"
              },
              "displayed_rating": 4
            },
            {
              "date": "2017-01-31",
              "ranking": {
                "position": 67,
                "properties_count": 361,
                "location": "Amsterdam"
              },
              "displayed_rating": 4
            },
            {
              "date": "2017-01-30",
              "ranking": {
                "position": 69,
                "properties_count": 361,
                "location": "Amsterdam"
              },
              "displayed_rating": 4
            }
          ]
        }
      ]
    }

Parameters

Parameter	Parameter Type	Data Types	Required	Description
id	path	Integer	true	The ID of the company.
since	query	Date	false	The start date in ISO 8601 format.

Response Statuses

Status Code	Reason
200	OK
404	The specified company was not found.
403	Client does not have access to the company.

Response Fields

Field	Data Types	Description
data	Hash

Olery Developer Portal

Reputation Management