Get social media by platform

get

https://sandbox-api.coris.ai/api/v0_2/establishment/{establishment_id}/social_media/{social_media_platform}/

Returns the profile of a business on one social media platform. Without request_id, Coris returns stored data or collects it during the call, which can be slow. With request_id, it returns the result of Request social media by platform.

Lifecycle: 425 means not ready, and 200 means complete. See Handle async requests.

sequenceDiagram
  accTitle: Get social media by platform sequence diagram
  accDescr: Get social media by platform. You send POST .../social_media/{platform}/. 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 .../social_media/{platform}/
  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

Time	Status	User Agent
Retrieving recent requests…

Loading…

Responses

425

Not ready. This applies only with request_id. Wait, then poll again.

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/html

200The social media result is ready.

400request_id belongs to a different resource. The body is a plain-text message. Send the request_id from the POST to this resource.

401The key is missing, or it is wrong for this host. Send Authorization: Token YOUR_API_KEY with a key issued for this environment.

403This feature is not enabled for your workspace, or your plan does not include it. Ask Coris support. A scoped key cannot use this route, and gets JSON with detail. Use a key without account limits.

404No item has this ID in your workspace. Check the ID and the environment.

422The job for this request_id failed. Send the POST again to start a new job.

429You passed a rate limit. If Retry-After is present, wait that many seconds, then retry. If it is absent, you hit the concurrency limit, so back off for a few seconds and reduce parallel calls.

500Coris could not complete the request. Retry with backoff. If it continues, contact support.