TOtogaihq
Event Management

Correct an ingested event

Changed on

This API lets you to correct events. Available in both synchronous and asynchronous mode

  • Usages: Reduction of all usages associated with this event
  • Revenue: Reduction of all revenues associated with this event
  • Entitlements: Entitlements(Feature Credits) consumed by this event are granted back to the account.

Possible Actions:

  • UNDO: Undo all usages, revenue and entitlements associated with an event
  • REDO: Performs UNDO and re-ingests the same event
  • REDO_EVENT: Performs UNDO and re-ingests the correction payload of the event
post/events/correction

Request

Query parameters

action'UNDO' | 'REDO' | 'REDO_EVENT' required
Example:UNDO

Action to perform in event correction

require_confirmationboolean

Specifies whether to start a migration only after a confirmation

Request body

Example request

{
  "event": {
    "id": "c0b1306d-f506-43a6-856b-69221efaee6b",
    "timestamp": "2022-06-15T07:30:35.123",
    "attributes": [
      {
        "name": "message",
        "unit": "characters"
      }
    ]
  }
}

Response

Success response

Example response

{
  "data": [
    {
      "eventPayload": {
        "id": "c0b1306d-f506-43a6-856b-69221efaee6b",
        "timestamp": "2022-06-15T07:30:35.123",
        "attributes": [
          {
            "name": "message",
            "unit": "characters"
          }
        ]
      },
      "ingestionStatus": {
        "status": "INGESTION_COMPLETED",
        "statusDescription": "Ingestion Completed successfully"
      },
      "customerId": "1",
      "createdAt": "2022-06-15T07:30:35.123"
    }
  ]
}

Changes

  • d078d3562056Revision changes
    • breaking

      the //////// response property's maxLength was increased from 50 to 200 for the response status

    • warning

      added the new INGESTION_FAILED_INSUFFICIENT_CREDITS enum value to the /////// response property for the response status

    • info

      the // request property's maxLength was increased from 50 to 200

  • cc0b10fb537eRevision changes
    • warning

      added the new INGESTION_FAILED_INVALID_NAMED_LICENSE_EVENT enum value to the /////// response property for the response status

    • info

      added the new optional query request parameter require_confirmation