Request reviews by source

Starts a job to collect customer reviews of a business from one source, by establishment_id. Use it when you prefer to pass establishment_id in the body or query.

Lifecycle: POST returns 201 and a request_id. Poll Get reviews by source with that request_id: 425 means not ready, and 200 means complete. If you send callback_url, Coris posts the result when it is done, as Handle async requests explains.

sequenceDiagram
  accTitle: Request reviews by source sequence diagram
  accDescr: Request reviews by source. You send POST /reviews/{source}/. Coris replies 201 request_id. You send GET ?request_id=... Coris replies 425 not ready. You send GET ?request_id=... Coris replies 200 complete. Coris sends POST callback_url, if sent.
  participant You
  participant Coris
  You->>Coris: POST /reviews/{source}/
  Coris-->>You: 201 request_id
  You->>Coris: GET ?request_id=...
  Coris-->>You: 425 not ready
  You->>Coris: GET ?request_id=...
  Coris-->>You: 200 complete
  Coris->>You: POST callback_url, if sent
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The source of the reviews, such as Google or Yelp. An unknown source returns no reviews and no error.

Body Params

Business Review Request

uuid
required

The Coris ID of the establishment.

uri

A public HTTPS URL where Coris posts the result, if you want to skip polling.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Callback
Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/html