Integration

Integration is done by creating a Station and then generating a Authentication Token for that Station. This token is then sent with every request from that Station so that Insight knows who is sending the event and that it is a trusted Station/Device.

Stations and Station Types

A Station is what we refer to a device that will send events to Insight. This can be a machine in a factory, an IoT device, a Webserver or some desktop application. Any single device that sends events.

As you could have several identical machines, devices, workstations, etc we identify them collectively as a Station Type and individually as a Station.

You will need to first create a Station Type so that you can create Stations within that type.

Create a Station Type

Navigate to Configuration > Station Configuration

Create a Station Type by clicking on the Add Station Type button and give it a name defining those Stations.

Create a Station

Now that you have a Station Type defined, click on the Add a Station button within that Station Type and give it a name that identifies that specific Station.

Sending events

Please also refer to the API menu within the Insight server for all available API's and the full JSON structure for those events.

Generate an Authentication Token for the Station that will be sending the events by clicking on the [key] icon next to that Station on the [Station Configuration] page. The examples below will use a dummy generated authentication token of ABCD1234.

Instance Event

The table below describes the basic object structure of the Instance events that you can send.

An example of sending an Instance Event.

# Note the trailing / on the end of the URL!
curl -X 'POST' \
  'https://mycompany.myinsights.nz/api/v1/events/' \
  -H 'Content-Type: application/json' \
  -H "Authorization: Token ABCD1234" \
  -d '{
      "instances": [
        {
          "tags": [
            {
              "tag_type_name": "Order Number",
              "value": "OD-123-456"
            },
            {
              "tag_type_name": "Batch",
              "value": "123456"
            }
          ],
          "instance_type_name": "Faulty container",
          "timestamp": "2022-11-02T22:32:14.352Z",
          "username": "Jack Sparrow"
        }
      ]
    }'

Starting Duration Events

The table below describes the basic object structure of the Duration events that you can send.

An example of starting a duration event which we will close next.

# Note the trailing / on the end of the URL!
curl -X 'POST' \
  'https://mycompany.myinsights.nz/api/v1/events/' \
  -H 'Content-Type: application/json' \
  -H "Authorization: Token ABCD1234" \
  -d '{
      "durations": [
        {
          "tags": [
            {
              "tag_type_name": "Order Number",
              "value": "OD-123-456"
            },
            {
              "tag_type_name": "Batch",
              "value": "123456"
            }
          ],
          "duration_type_name": "stoppage",
          "start_time": "2022-11-02T22:32:14.352Z",
          "username_start": "Bob",
          "context_identifier": "12",
        }
      ]
    }'

Ending Duration Events

If multiple durations are opened by a Station and you need to end a specific duration, you need to specify the context_identifier of the Duration you started.

The context_identifier is a way for a Station to keep track of its open durations, so it can end them later. This only has to be unique within this Station's open duration events. context_identifier's can be reused as soon as the duration using that context_identifier on that Station is closed.

# Don't forget the trailing / on the end!
curl -X 'POST' \
  'https://mycompany.myinsights.nz/api/v1/events/' \
  -H 'Content-Type: application/json' \
  -H "Authorization: Token ABCD1234" \
  -d '{
      "durations": [
        {
          "tags": [
            {
              "tag_type_name": "Order Number",
              "value": "OD-123-456"
            },
            {
              "tag_type_name": "Batch",
              "value": "123456"
            }
          ],
          "duration_type_name": "stoppage",
          "end_time": "2022-11-02T22:32:14.352Z",
          "username_end": "Bob",
          "context_identifier": "12",
        }
      ]
    }'

Retrieving a report

Please refer to the API menu within the Insight application for all available API's.

To retrieve a JSON formatted report for one of the created reports on Insight, you can do something like the below where the specific report of interest has an ID of 1.

curl -H "Authorization: Token ABCD1234" https://mycompany.myinsights.nz/api/v1/reports/graphs/1/run/

This will return something similar to the following for a report on Instance:

{
  "title": "My Error Duration Counts",
  "type": "bar",
  "data": {
    "Station 3": {
      "Error X": 4011.0
    },
    "Station 2": {
      "Error X": 2811.0
    },
    "Station 1": {
      "Error X": 1524.0
    }
  },
  "isDuration": false,
  "stackedGroups": false,
  ...
}