Gainsight · Schema

Engagement

Properties

Name Type Description
id string Engagement identifier
name string Engagement name
type string Engagement type
state string Engagement state
createdDate integer Creation timestamp
View JSON Schema on GitHub

JSON Schema

gainsight-engagement-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Engagement",
  "title": "Engagement",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Engagement identifier"
    },
    "name": {
      "type": "string",
      "description": "Engagement name"
    },
    "type": {
      "type": "string",
      "enum": [
        "Dialog",
        "Slider",
        "Guide",
        "Tooltip",
        "Hotspot",
        "Badge"
      ],
      "description": "Engagement type"
    },
    "state": {
      "type": "string",
      "enum": [
        "DRAFT",
        "LIVE",
        "PAUSED",
        "STAGED"
      ],
      "description": "Engagement state"
    },
    "createdDate": {
      "type": "integer",
      "format": "int64",
      "description": "Creation timestamp"
    }
  }
}