Request account websites

post

https://sandbox-api.coris.ai/api/v0_2/accounts/{account_id}/websites/

Starts a job to get attributes for each website on an account, and adds new URLs in websites to the account. To add or remove websites without analyzing them, use Update account websites.

Lifecycle: poll List account websites with the request_id: 425 means not ready, 206 means partial data, and 200 means complete (see Handle async requests).

sequenceDiagram
  accTitle: Request account websites sequence diagram
  accDescr: Request account websites. You send POST .../websites/. Coris replies 201 request_id. You send GET ?request_id=... Coris replies 425 not ready, or 206 partial data. You send GET ?request_id=... Coris replies 200 complete. Coris sends POST callback_url, if sent.
  participant You
  participant Coris
  You->>Coris: POST .../websites/
  Coris-->>You: 201 request_id
  You->>Coris: GET ?request_id=...
  Coris-->>You: 425 not ready, or 206 partial data
  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…

Path Params

account_id

string

required

The account's Coris ID or your reference_id. Example: your_id_1.

Body Params

Account Website Request

websites

array of strings

A list of full website URLs to get attributes for, or omit it to use all websites on the account. Coris normalizes URLs and adds new ones to the account, though duplicates can occur.

websites

sources

array of strings

A list of website sources to include, such as stripe or api, or omit it to use all sources.

sources

Allowed:

callback_url

uri

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

min_callback_delay

integer

The minimum delay before the callback, in seconds, up to a recommended 3600. Send it if you might receive the callback before you store request_id.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Callback

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

201The job started. Use request_id to get the result.

400callback_url is not a valid URL. The body is a plain-text message. Fix the URL and resend.

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

403A 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.

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.