getAutomationMap

Your organization's Automations Map. When there is none, this read draws it from the organization's workflows and AI employees (no agent turn) and saves it; null when there is nothing to draw. story (a MapStory: journeys, steps, edges and each step's detail, as JSON), refStates (each workflow or AI employee a step stands for, with its state now: on, off or draft, and its setup as label/value facts), and changedSince (records saved after this version: the Map may be out of date until the Automations chat redraws it). story null means the current version cannot be read. pageId and version are what the version ops take.

curl https://server.goliathdata.com/api/v1/call \
  -H "Authorization: Bearer $GOLIATH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "operationId": "getAutomationMap",
    "variables": {}
  }'

import { GoliathClient } from '@goliath-data/sdk'

const goliath = new GoliathClient({
  apiKey: process.env.GOLIATH_API_KEY!,
  baseUrl: 'https://server.goliathdata.com',
})

const result = await goliath.automationMap.getAutomationMap()

const res = await fetch('https://server.goliathdata.com/api/v1/call', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.GOLIATH_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    operationId: 'getAutomationMap',
    variables: {}
  }),
})
const { data, errors } = await res.json()

Variables

None. Send "variables": {}.

Response

What comes back under data: a list shows as one entry, and a value as its type.

response shape

{
  "data": {
    "automationPagesQuery": {
      "map": {
        "pageId": "<ID>",
        "version": 0,
        "story": "…",
        "refStates": [
          {
            "kind": "…",
            "id": "<ID>",
            "name": "…",
            "state": "…",
            "editing": true,
            "domain": "…",
            "channels": [
              "…"
            ],
            "facts": [
              {
                "label": "…",
                "value": "…"
              }
            ]
          }
        ],
        "changedSince": [
          {
            "kind": "…",
            "id": "<ID>",
            "name": "…",
            "onMap": true,
            "change": "…"
          }
        ]
      }
    }
  }
}

Errors

400unknown_variable

A variable the operation does not declare. A typo is refused rather than silently dropped.

401unauthorized

No bearer header, or the key is invalid or revoked.

403insufficient_scope

The key lacks the scope the operation requires.

403forbidden

A referenced record does not exist, was deleted, or is outside your organization. The gateway cannot tell those apart.

Behaviour

A read. It rejects an Idempotency-Key header with 400 bad_request.

curl https://server.goliathdata.com/api/v1/call \ -H "Authorization: Bearer $GOLIATH_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "operationId": "getAutomationMap", "variables": {} }'

import { GoliathClient } from '@goliath-data/sdk' const goliath = new GoliathClient({ apiKey: process.env.GOLIATH_API_KEY!, baseUrl: 'https://server.goliathdata.com', }) const result = await goliath.automationMap.getAutomationMap()

const res = await fetch('https://server.goliathdata.com/api/v1/call', { method: 'POST', headers: { Authorization: `Bearer ${process.env.GOLIATH_API_KEY}`, 'Content-Type': 'application/json', }, body: JSON.stringify({ operationId: 'getAutomationMap', variables: {} }), }) const { data, errors } = await res.json()

Variables

Response

Errors

Behaviour

Related