API Documentation

The re:spondelligent BI API lets you retrieve your review data programmatically and integrate it into your own systems, for example internal dashboards, reporting tools, or automated analyses.

The API provides three endpoints: Locations, Reviews, and Sentiments. Together, these three endpoints represent the complete data model, allowing you to link locations, reviews, and sentiment analyses

Authentication

The API uses Basic Authentication. You will receive your credentials (username and password) directly from us. All requests are made against the following base URL:

https://app.respondelligent.com

The Three Endpoints

1. Locations

Returns all locations in your account with their respective Location ID.

Endpoint:
https://app.respondelligent.com/{ihr-account}/bi/location

2. Reviews

Returns all reviews. Each review contains a Review ID and a Location ID, allowing you to map it to the corresponding location.

Endpoint:
https://app.respondelligent.com/{ihr-account}/bi/review?filter[yearmonth]=yyyy-mm

3. Sentiments

Returns the sentiment analysis per Review ID. A review can contain multiple sentiments, e.g. “Friendliness”, “Cleanliness”, or “Food”. Each sentiment has a rating from 1 (poor) to 5 (excellent), analogous to the star rating scale.

Endpoint:
https://app.respondelligent.com/{ihr-account}/bi/sac?filter[yearmonth]=yyyy-mm

Data Model and Relationships

The three endpoints are linked via IDs:

Location → has a Location ID

Review → has a Review ID and a Location ID (maps to location)

Sentiment → has a Review ID (maps to review)

Recommended Workflow

Step 1: Fetch Locations (only necessary, if you manage more than one). Load all your locations via the Locations endpoint. This gives you the Location IDs as a reference.

Step 2: Fetch Reviews. Retrieve your reviews via the Reviews endpoint. Each review contains a Location ID that lets you map it to the corresponding location.

Step 3: Fetch Sentiments. Load the sentiment data via the Sentiments endpoint. Link these to the respective review via the Review ID, and by extension to the location.

With these three steps, you can build analyses such as: “10 reviews mentioned the service positively last month” or “The Zurich location has an average cleanliness rating of 4.2”.

Response Format

All endpoints return data in JSON format. The data can be processed directly in common programming languages and tools.

Questions?

If you have questions about the integration or need support with the setup, contact us any time at [email protected].