HTTP API

The SDKs are a convenience: underneath, every one of them makes the HTTP requests on this page. Use the API directly from a language without an SDK, from a script or from CI.

Before you start

You need three things, all from the project settings in CloseYourIt:

• the address of your install, for example https://bugs.example.com;
• the project id;
• an ingest token (cyi_…).

The token is secret and stays on the server. ingest allows sending; private reads require the separate read scope. Browser and mobile clients use a public key for supported signals, without reading or administration access. Available signals depend on the SDK and version; see JavaScript SDK.

Every request carries the token and sends JSON, with field names in snake_case:

Authorization: Bearer cyi_...
Content-Type: application/json

Where to send

The <id> in the address must be the project the token belongs to.

202 means accepted, not saved: the data is written a moment later by a background job. accepted counts the items that passed the first checks.

Send an error

The body is a Sentry-style event.

curl -X POST https://bugs.example.com/api/v1/projects/$PROJECT_ID/events \
  -H "Authorization: Bearer $CYI_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "event_id": "fc6d8c0c43fc4630ad850ee518f1b9d0",
    "timestamp": "2026-10-03T10:15:30Z",
    "level": "error",
    "platform": "ruby",
    "environment": "production",
    "release": "v1.4.2",
    "exception": { "values": [ {
      "type": "RuntimeError",
      "value": "boom",
      "stacktrace": { "frames": [
        { "filename": "app/models/order.rb", "function": "charge", "lineno": 42, "in_app": true }
      ] }
    } ] }
  }'

Errors are grouped by exception type and place in the code, not by the message text.

Send logs

curl -X POST https://bugs.example.com/api/v1/projects/$PROJECT_ID/logs \
  -H "Authorization: Bearer $CYI_TOKEN" \
  -H "Content-Type: application/json" \
  -d '[
    { "timestamp": "2026-10-03T10:15:30Z", "level": "info", "message": "order charged",
      "logger": "billing", "attributes": { "order_id": 7 } }
  ]'

Send performance samples

curl -X POST https://bugs.example.com/api/v1/projects/$PROJECT_ID/metrics \
  -H "Authorization: Bearer $CYI_TOKEN" \
  -H "Content-Type: application/json" \
  -d '[
    { "kind": "slow_query", "duration_ms": 812.4,
      "sql": "SELECT * FROM orders WHERE id = 7", "environment": "production" },
    { "kind": "slow_method", "duration_ms": 240.0, "label": "Invoice#render" }
  ]'

Send page views

curl -X POST https://bugs.example.com/api/v1/projects/$PROJECT_ID/pageviews \
  -H "Authorization: Bearer $CYI_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "hostname": "www.example.com", "path": "/pricing",
        "referrer": "https://www.google.com/", "utm_source": "newsletter" }'

No cookie is used. The visitor is counted from a hash that changes every day and cannot be turned back into a person. A request that looks like a bot gets 202 with accepted: 0.

Page views need the secret token, so this address is called from your server, not from the browser. For a website, use the JavaScript SDK.

Limits

Over a size limit the answer is 413 and nothing is saved. Over a rate limit the answer is 429 with a Retry-After header, in seconds.

With the ingest gateway on, one request can be at most 5 MB.

When something goes wrong

An error answer looks like this:

{ "error": { "code": "R422-LOG-004", "message": "…" } }

To retry safely, keep the same event_id or sample_id: CloseYourIt then ignores the copy if the first attempt had arrived. Replay chunks are the exception: a retried chunk can be stored twice.

Read data back

The same token reads the project's data. Each address returns the latest 25 items.

curl -H "Authorization: Bearer $CYI_TOKEN" \
  "https://bugs.example.com/api/v1/error_groups?status=unresolved"

To mark an error as resolved: PUT /api/v1/error_groups/<id>/resolution. To reopen it: DELETE on the same address.

Coming from Sentry

Applications that already use a Sentry SDK do not need this page: they keep their SDK and change one setting. See Sentry SDK.