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

For a property, this endpoint returns an overview of all supported reviews sources and existing source connections.

This should be your starting point when building an interface to see a property’s connections and submit connection suggestions.

2 types of items for each source are returned:

Connections: current mapped links to the property profile on the source
Connection Suggestions: submitted suggestions for changes to the connections

Connections

A connection is a link to the property’s profile on one of the supported sources (Booking.com, Expedia etc).Connections are required to capture reviews. Generally, a property has only one connection for each source.

Connection Suggestions

When you or your customers wants to create, update or delete a connection, you can use an endpoint to submit a suggestion, which will be manually moderated. Please, refer to Connection Suggestion documentation for more details.

Connection Searches

When you activate a property, automatic and manual processes try to find and create as many connections as possible. The currently_searching field indicates that such a process is currently taking place.

We recommend to wait until the search is completed before submitting connection suggestions.

Example Request

https://agora.olery.com/v3/companies/123/sources?auth_token=123456

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:

Field	Data Types	Description
name	String	Identifier of the source (a slug from the name)
friendly_name	String	Friendly name of the source
url_pattern	String	Pattern required to save a connection URL
url_pattern_instructions	String	Details regarding the connection URL
connections	Array	Connections for this property and source
currently_searching	Boolean	Connection search status
suggestions	Array	Suggestions for this property and source
authorization	String	It can be ‘not_available’, ‘active’ or ‘inactive’

Connection fields

Field	Data Types	Description
id	Integer	Identifier of the connection
url	String	URL of the property on the source’s website
displayed_rating	Float	Rating being displayed on the source’s website

Suggestion fields

Field	Data Types	Description
id	Integer	ID of the suggestion
action	String	create, update or delete
company_id	Integer	ID of the property
source_id	Integer	ID of the source
connection_id	Integer	ID of the connection, empty for action create
suggested_url	String	Suggested URL, empty for action delete
reject_reason	String	Reason if the suggestion was rejected
status	String	Status of the suggestion
created_at	Time	Date and time of suggestion creation
created_at	Time	Date and time of moderation

Example Output

{
  "data": [
    {
      "name": "agoda",
      "friendly_name": "Agoda",
      "url_pattern": "^http(s)?:\\/\\/www\\.agoda.(com)\\/[^\\/]+\\/(?!reviews|attractions\\/).+$",
      "url_pattern_instructions": null,
      "connections": [
        {
          "id": 82668,
          "url": "https://www.agoda.com/hotel-casa-amsterdam/hotel/amsterdam-nl.html"
        }
      ],
      "currently_searching": false,
      "suggestions": [

      ]
    },
    {
      "name": "booking_com",
      "friendly_name": "Booking.com",
      "url_pattern": "^https?:\\/\\/www\\.booking\\.com\\/hotel\\/\\w+\\/[\\w\\.\\-]+\\.html$",
      "url_pattern_instructions": null,
      "connections": [
        {
          "id": 113,
          "url": "https://www.booking.com/hotel/nl/casa-400.en-gb.html",
          "displayed_rating": 4.5
        }
      ],
      "currently_searching": true,
      "suggestions": [
        {
          "id": 3,
          "company_id": 38,
          "source_id": 4,
          "connection_id": 113,
          "action": "update",
          "suggested_url": "https://www.booking.com/hotel/gr/villa-casa.en-us.html",
          "status": "pending",
          "reject_reason": null,
          "created_at": "2018-03-26T16:14:45.695-03:00",
          "moderated_at": null
        },
      ]
    },
    {
      "name": "ebookers",
      "friendly_name": "Ebookers",
      "url_pattern": "^https://www.ebookers.com/.*h\\d+\\.Hotel",
      "url_pattern_instructions": "You only need to submit one URL from the Expedia Group (expedia ebookers, orbitz, lastiminute, travelocity, cheaptickets, wotif). Connections for the other sources will be created automatically.",
      "connections": [
        {
          "id": 5966450,
          "url": "https://www.ebookers.com/Amsterdam-Hotels-Hotel-Casa-Amsterdam.h108881.Hotel-Information",
          "displayed_rating": 4.5
        }
      ],
      "currently_searching": false,
      "suggestions": [

      ]
    },
    {
      "name": "airbnb",
      "friendly_name": "AirBnB",
      "url_pattern": "^https:\\/\\/www\\.airbnb\\.com\\/rooms\\/\\d+$",
      "url_pattern_instructions": null,
      "connections": [

      ],
      "currently_searching": false,
      "suggestions": [

      ]
    },
    {
      "name": "rooms_for_africa",
      "friendly_name": "Rooms for Africa",
      "url_pattern": "^http(s)?:\\/\\/www\\.roomsforafrica\\.com\\/establishment\\.do\\?id=[0-9]+",
      "url_pattern_instructions": null,
      "connections": [

      ],
      "currently_searching": false,
      "suggestions": [

      ]
    },
    {
      "name": "goibibo",
      "friendly_name": "goibibo.com",
      "url_pattern": "https:\\/\\/www\\.goibibo\\.com\\/hotels\\/.+-\\d{1,}.*",
      "url_pattern_instructions": null,
      "connections": [

      ],
      "currently_searching": false,
      "suggestions": [

      ]
    },
    {
      "name": "cheaptickets",
      "friendly_name": "CheapTickets",
      "url_pattern": "^https?:\\/\\/(?:www\\.)?cheaptickets\\.(com|nl|com.ph|co.uk|co.in|ca|com.au|)\\/[\\w\\-\\d\\.]+Hotel-Information$",
      "url_pattern_instructions": "You only need to submit one URL from the Expedia Group (expedia ebookers, orbitz, lastiminute, travelocity, cheaptickets, wotif). Connections for the other sources will be created automatically.",
      "connections": [
        {
          "id": 1117595,
          "url": "https://www.cheaptickets.com/Amsterdam-Hotels-Hotel-Casa-Amsterdam.h108881.Hotel-Information?forceNoRedir=1"
        }
      ],
      "currently_searching": false,
      "suggestions": [

      ]
    },
    {
      "name": "hotels_nl",
      "friendly_name": "Hotels.nl",
      "url_pattern": "^http(s)?:\\/\\/www\\.hotels.(nl)\\/[a-zA-Z0-9_\\-.\\/]+$",
      "url_pattern_instructions": null,
      "connections": [
        {
          "id": 1216,
          "url": "http://www.hotels.nl/amsterdam/casa/"
        }
      ],
      "currently_searching": true,
      "suggestions": [

      ]
    }
  ]
}