Custom Integration API Mapping Config Object

Schema for defining the set of payload-to-Moogsoft field mappings for a custom endpoint

A config object defines the mappings of payload fields to Moogsoft fields for a custom endpoint. Draft configs refer to mappings for provisioned endpoints. Live configs define mappings for active endpoints.

    {
      "data": {
        "batchKey": "web.pageLoad",
        "mappings": [
          {...mapping 0...},
          {...mapping 1...},
          {
            "delimiter": "-",
            "paths": [
              {
                "path": "web.test.testName",
                "source": true
              },
              {
                "path": "web.pageLoad[*].agentName",
                "source": true
              }
            ],
            "targetPath": {
              "path": "metric.source",
              "source": false
            },
            "type": "CONCATENATED"
          },
          {...mapping 3...}
    }

batchKey

string

The key of the root object for payloads that include multiple events or metrics under one object. See Batch Processing with Custom Integrations.

mappings

JSON list

A list of all the mappings from a payload field (the source) to a Moogsoft event or metric field (the target). The source boolean indicates whether that field is in a payload field (true) or only a target field (false).

delimiter

string

The character sequence that delineates multiple source fields that get mapped to the same target field. Specified only if the mapping type = "CONCATENATED".

paths

string

The list of input fields in the payload data.

targetPath

string

The Moogsoft data field to which the payload input fields get mapped.

type

string

The mapping type. Can be "BASIC", "CONCATENATED", or "CONDITIONAL". See See Use mapping types in custom integrations.