erp

listErpUpdateCorrelations

Changed on

Lists the organization's interactive correlations, newest first by the time their first event was ingested, with the same summary the correlation wait returns.

It exists because looking a correlation up by id only finds the ones somebody already has an id for. A correlation that is merely stuck emits no monitoring code, so nothing points at it — and that is the case most worth seeing.

The listing covers the last 7 days — the lifetime of a correlation record — and says so in horizon_days. Correlations older than that are not returned, even when a wider range is being displayed.

Pass next_cursor back as cursor for the next page. Only a null next_cursor ends the listing: a page can be shorter than limit, even empty, and still carry a cursor — a page filtered to an integration stops after reading a bounded number of rows, whichever integration they belong to. A cursor whose position has aged past the 7 days answers an empty last page; a cursor this endpoint did not issue is a 400.

Requires integration:view on integration_id when it is given, and on every integration of the organization when it is not.

get/v3/erp/updates/correlations

Request

  • Base URL
    https://integration-toolkit.sls.epilot.io
  • URL
    https://integration-toolkit.sls.epilot.io/v3/erp/updates/correlations
  • Auth
    HTTP bearer

Query parameters

integration_idstring uuid

Only correlations of this integration. Must be a UUID.

limitinteger

Page size. Values above 100 are clamped to 100.

cursorstring

Opaque cursor from a prior page's next_cursor. Opaque, but not secret: it names the last row the page read, which on a page filtered to an integration may be a correlation of another integration of the organization — its correlation id and the time its first event was ingested. Do not put anything in a correlation id you would not want reflected back to a caller who can list another integration.

Response

Correlations, newest first

next_cursorstring nullable required

Cursor for the next page; null when there are no more rows. Only null ends the listing: a short or even empty page can still carry a cursor.

horizon_daysinteger required

How many days back the listing reaches — the lifetime of a correlation record. Nothing older is ever returned.

Example response

{
  "results": [
    {
      "entities": [
        {
          "slug": "contact",
          "unique_ids": {
            "reenumber": "4711"
          }
        }
      ]
    }
  ],
  "horizon_days": 7
}

Changes

    • info

      added the optional property // to the response with the status

    • breaking

      added the pattern ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ to the query request parameter integration_id

    • info

      added the optional property // to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status