Reachora Recommendations for ESC

Presentation Recommendations

• Endpoint: https://recommendations.reachora.com/esc/presentations
• Method: GET or POST
• Username: customers.esc
• Password: Communicated privately to you

Request Options

• resource_id: The identifier of the current presentation in the format of “{event_id}:{presentation_id}”.
• user_id: The ESC identifier for a user.
• count: The amount of recommendations you would like returned.
• search_context: The search query that was made to get to this resource, used as additional context.

Coming Soon

• personalisation_token: for personalising non-logged-in users.
• excluded_resource_ids: for filtering out particular presentations.

Response

• results: An array of presentation ids in the format of “{event_id}:{presentation_id}”.
• requested_with: The parameters that were passed to us, which we understood.
• recommended_with: The parameters we used to make the recommendation.

Example

Request

GET https://recommendations.reachora.com/esc/presentations?resource_id=696:164171&user_id=EYkoAxsVth3Lww82Yj8ETA==

Response

{
  "results": [
    "696:164680",
    "696:164679",
    "696:164681",
    "696:165297"
  ],
  "requested_with": {
    "resource_id": "696:164171",
    "user_id": "EYkoAxsVth3Lww82Yj8ETA==",
  },
  "recommended_with": {
    "resource_id": "696:164171",
    "user_id": "...",
    "tracking_id": null,
    "excluded_resource_ids": [],
    "count": 5
  }
}

Presentation Publish/Unpublish

• Publish endpoint: https://recommendations.reachora.com/esc/presentation/<resourceId>/publish
• Unpublish endpoint: https://recommendations.reachora.com/esc/presentation/<resourceId>/unpublish
• Method: PUT
• Username: customers.esc
• Password: Communicated privately to you (same as the one used to get recommendations)

The <resourceId> parameter is the combined event ID and presentation ID: <eventId>:<presentationId>.

So if presentation “123456” from event “852” has been cancelled, you’d need to make a PUT request to /esc/presentation/852:123456/unpublish.

The response should be a 200 OK, with an empty body.

New Events to Process

Whenever there’s a new XML file for an event for us to process, this endpoint will set it up:

• Endpoint: https://recommendations.reachora.com/esc/events/<eventId>
• Method: POST
• Username: customers.esc
• Password: Communicated privately to you (same as the one used to get recommendations)

So if there’s a new event, “999”, you’d need to make a POST request to /esc/events/999. We’ll download the file in the evening, and the data should be imported by the next day.

The response should be a 200 OK, with an empty body.