Listing issues through Management API

Listing issues through Management API#

This article documents how to list and acknowledge issues through the Management API and how to retry an action that has failed.

Listing issues through Management API#

To use Management API to list issues that have occurred, follow these steps:

  1. Create a GET request to the following endpoint:

    https://{{INSTANCE}}/api/errors/

  2. In the HTTP request header, include the parameter Authorization with one of the following values:

    • Token {{KEY}} if you use a key generated with user credentials in Management API.

    • Bearer {{KEY}} if you use a key generated in the Adverity user interface.

  3. Send the request.

As a result, you obtain a response containing a list of the issues that have occurred.

Import the request example as raw text to your HTTP client (such as Postman). The cURL request example is the following:

curl --request GET 'https://{{INSTANCE}}/api/errors/' \
--header 'Authorization: Token {{KEY}}'

Example of JSON response (cropped to show one issue):

{
   "count": XX,
   "next": null,
   "previous": null,
   "results":
   [
      {
         "id": ERROR_ID,
         "start": "YYYY-MM-DDTHH:MM:SSZ",
         "end": "YYYY-MM-DDTHH:MM:SSZ",
         "duration": "0s",
         "message": "This error occurred.",
         "type_label": "General",
         "datastream": {
            "id": DATASTREAM_ID,
            "stack_id": STACK_ID,

            "stack": {
               "add_connection_url": "/core/authorization/add/",
               "add_datastream_url": "/core/apidatastream/add/",
               "change_url": "/core/stack/STACK_ID/change/",
               "datalake": "https://YOUR_STACK.adverity.com/api/storage/STORAGE_ID/",
               "destination": DESTINATION_ID,
               "extracts_url": "/core/datastreamextract/?stack_id=STACK_ID",
               "issues_url": "/core/datastreamextractionlog/?ack__exact=0&stack_id=STACK_ID",
               "id": STACK_ID,
               "name": "STACK_NAME",
               "overview_url": "/STACK_SLUG/",
               "parent": "https://YOUR_STACK.datatap.adverity.com/api/stacks/PARENT/",
               "parent_id": PARENT_ID,
               "slug": "STACK_SLUG",
               "url": "https://YOUR_STACK.datatap.adverity.com/api/stacks/STACK_SLUG/",
               "counts": {
                  "connections": XX,
                  "datastreams": ZZ
               },

               "permissions": {
                  "isDatastreamManager": true
               },

               "default_manage_extract_names": true
            },

            "name": "DATASTREAM_NAME",
            "slug": "DATASTREAM_SLUG",
            "app_label": "APP_LABEL",
            "absolute_url": "https://YOUR_STACK.datatap.adverity.com/APP_LABEL/DATASTREAM_ID/DATASTREAM_SLUG/",
            "change_url": "/APP_LABEL/APP_LABELdatastream/DATASTREAM_ID/change/",
            "extracts_url": "/datastream/DATASTREAM_ID/extracts/all",
            "fetch_url": "https://YOUR_STACK.datatap.adverity.com/APP_LABEL/DATASTREAM_ID/DATASTREAM_SLUG/?action=fetch",
            "overview_url": "/STACK_SLUG/DATASTREAM_SLUG-DATASTREAM_ID/",
            "enabled": false,
            "next_run": "Disabled",
            "url": "https://YOUR_STACK.datatap.adverity.com/api/datastreams/DATASTREAM_ID/",
            "datastream_type_id": DATASTREAM_TYPE_ID,
            "logo_url": "/static/images/api/APP_LABEL.svg",
            "extracts_stream_url": "/api/datastreams/DATASTREAM_ID/extracts/streaming/download/",
            "supports_extended_intervals": false,
            "updated": "YYYY-MM-DDTHH:MM:SSZ",
            "creator": "CREATOR_USERNAME"
         },
         "extract": null,
         "ack": false,
         "ack_url": "/api/errors/ERROR_ID/confirm/",
         "retry_url": "/api/errors/ERROR_ID/retry/",
         "mapping_table_change_url": null,
         "mapping_entries_change_url": null,
         "target_column_change_url": null,
         "transformation_config_url": null,
         "url": "https://YOUR_STACK.datatap.adverity.com/api/errors/ERROR_ID/",
         "datastream_insights_url": null
      }
   ]
}

Listing issues that have occurred for a specific datastream through Management API#

To use Management API to list issues that have occurred for a specific datastream, follow these steps:

  1. Create a GET request to the following endpoint:

    Replace {{DATASTREAM_ID}} with the datastream’s ID.

    https://{{INSTANCE}}/api/errors/?datastream_id={{DATASTREAM_ID}}

  2. In the HTTP request header, include the parameter Authorization with one of the following values:

    • Token {{KEY}} if you use a key generated with user credentials in Management API.

    • Bearer {{KEY}} if you use a key generated in the Adverity user interface.

  3. Send the request.

As a result, you obtain a response containing a list of the issues that have occurred for this specific datastream.

Import the request example as raw text to your HTTP client (such as Postman). The cURL request example is the following:

curl --request GET 'https://{{INSTANCE}}/api/errors/?datastream_id={{DATASTREAM_ID}}' \
--header 'Authorization: Token {{KEY}}'

Acknowledging issues through Management API#

To acknowledge an issue through Management API, follow these steps:

  1. Respond to the issue with ACK_URL.

As a result, the issue will no longer be shown in Adverity’s user interface.

Retrying a failed action#

To retry a failed action through Management API that has failed, follow these steps:

  1. Respond to the issue with RETRY_URL.

As a result, the most recent action will be repeated.

Contents