Skip to main content

Uniphore Customer Portal

6. Query Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "type": {
      "type": "string"
    },
    "filters": {
      "type": "object",
      "properties": {
        "startTime": {
          "type": "integer"
        },
        "endTime": {
          "type": "integer"
        },
        "id": {
          "type": "array",
          "items": [
            {
              "type": "string"
            },
            {
              "type": "string"
            },
            {
              "type": "string"
            },
            {
              "type": "string"
            }
          ]
        },
        "lang": {
          "type": "array",
          "items": [
            {
              "type": "string"
            },
            {
              "type": "string"
            },
            {
              "type": "string"
            },
            {
              "type": "string"
            }
          ]
        },
        "sessionId": {
          "type": "array",
          "items": [
            {
              "type": "string"
            },
            {
              "type": "string"
            },
            {
              "type": "string"
            },
            {
              "type": "string"
            },
            {
              "type": "string"
            }
          ]
        },
        "metadata": {
          "type": "object",
          "properties": {
            "agentId": {
              "type": "array",
              "items": [
                {
                  "type": "string"
                },
                {
                  "type": "string"
                }
              ]
            },
            "categoryId": {
              "type": "array",
              "items": [
                {
                  "type": "string"
                },
                {
                  "type": "string"
                }
              ]
            },
            "organizationId": {
              "type": "array",
              "items": [
                {
                  "type": "string"
                },
                {
                  "type": "string"
                }
              ]
            },
            "customerId": {
              "type": "array",
              "items": [
                {
                  "type": "string"
                },
                {
                  "type": "string"
                }
              ]
            },
            "clientContactId": {
              "type": "array",
              "items": [
                {
                  "type": "string"
                },
                {
                  "type": "string"
                }
              ]
            },
            "contactId": {
              "type": "array",
              "items": [
                {
                  "type": "string"
                },
                {
                  "type": "string"
                }
              ]
            },
            "type": {
              "type": "array",
              "items": [
                {
                  "type": "string"
                },
                {
                  "type": "string"
                }
              ]
            },
            "contactType": {
              "type": "array",
              "items": [
                {
                  "type": "string"
                },
                {
                  "type": "string"
                }
              ]
            },
            "convId": {
              "type": "array",
              "items": [
                {
                  "type": "string"
                },
                {
                  "type": "string"
                }
              ]
            },
            "msgId": {
              "type": "array",
              "items": [
                {
                  "type": "string"
                },
                {
                  "type": "string"
                }
              ]
            },
            "sub": {
              "type": "array",
              "items": [
                {
                  "type": "string"
                },
                {
                  "type": "string"
                }
              ]
            },
            "from": {
              "type": "array",
              "items": [
                {
                  "type": "string"
                },
                {
                  "type": "string"
                }
              ]
            },
            "to": {
              "type": "array",
              "items": [
                {
                  "type": "string"
                },
                {
                  "type": "string"
                }
              ]
            },
            "journeyId": {
              "type": "array",
              "items": [
                {
                  "type": "string"
                },
                {
                  "type": "string"
                }
              ]
            },
            "incDiarized": {
              "type": "boolean"
            },
            "isDiarized": {
              "type": "boolean"
            },
            "incContactDuration": {
              "type": "boolean"
            },
            "minContactDuration": {
              "type": "integer"
            },
            "maxContactDuration": {
              "type": "integer"
            },
            "agentClientId": {
              "type": "array",
              "items": [
                {
                  "type": "string"
                },
                {
                  "type": "string"
                }
              ]
            },
            "customerClientId": {
              "type": "array",
              "items": [
                {
                  "type": "string"
                },
                {
                  "type": "string"
                }
              ]
            }
          },
          "required": [
            "agentId",
            "categoryId",
            "organizationId",
            "customerId",
            "clientContactId",
            "contactId",
            "type",
            "contactType",
            "convId",
            "msgId",
            "sub",
            "from",
            "to",
            "journeyId",
            "incDiarized",
            "isDiarized",
            "incContactDuration",
            "minContactDuration",
            "maxContactDuration",
            "agentClientId",
            "customerClientId"
          ]
        },
        "entity": {
          "type": "object",
          "properties": {
            "incUsedInSummary": {
              "type": "boolean"
            },
            "usedInSummary": {
              "type": "boolean"
            },
            "turnId": {
              "type": "array",
              "items": [
                {
                  "type": "integer"
                },
                {
                  "type": "integer"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "incReviewed": {
              "type": "boolean"
            },
            "isReviewed": {
              "type": "boolean"
            }
          },
          "required": [
            "incUsedInSummary",
            "usedInSummary",
            "turnId",
            "incReviewed",
            "isReviewed"
          ]
        },
        "disposition": {
          "type": "object",
          "properties": {
            "userId": {
              "type": "array",
              "items": [
                {
                  "type": "string"
                },
                {
                  "type": "string"
                }
              ]
            },
            "hierarchy": {
              "type": "array",
              "items": [
                {
                  "type": "string"
                },
                {
                  "type": "string"
                }
              ]
            }
          },
          "required": [
            "userId",
            "hierarchy"
          ]
        },
        "manualEdits": {
          "type": "object",
          "properties": {
            "userId": {
              "type": "array",
              "items": [
                {
                  "type": "string"
                },
                {
                  "type": "string"
                }
              ]
            },
            "hierarchy": {
              "type": "array",
              "items": [
                {
                  "type": "string"
                },
                {
                  "type": "string"
                }
              ]
            }
          },
          "required": [
            "userId",
            "hierarchy"
          ]
        },
        "speakerVerification": {
          "type": "object",
          "properties": {
            "attempt": {
              "type": "array",
              "items": [
                {
                  "type": "integer"
                },
                {
                  "type": "integer"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "speakerId": {
              "type": "array",
              "items": [
                {
                  "type": "string"
                },
                {
                  "type": "string"
                }
              ]
            },
            "score": {
              "type": "array",
              "items": [
                {
                  "type": "integer"
                },
                {
                  "type": "integer"
                },
                {
                  "type": "integer"
                },
                {
                  "type": "integer"
                }
              ]
            }
          },
          "required": [
            "attempt",
            "speakerId",
            "score"
          ]
        },
        "alerts": {
          "type": "object",
          "properties": {
            "sequenceNumber": {
              "type": "array",
              "items": [
                {
                  "type": "integer"
                },
                {
                  "type": "integer"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "incResolved": {
              "type": "boolean"
            },
            "resolved": {
              "type": "boolean"
            },
            "name": {
              "type": "array",
              "items": [
                {
                  "type": "string"
                },
                {
                  "type": "string"
                }
              ]
            },
            "message": {
              "type": "array",
              "items": [
                {
                  "type": "string"
                },
                {
                  "type": "string"
                }
              ]
            },
            "type": {
              "type": "array",
              "items": [
                {
                  "type": "string"
                },
                {
                  "type": "string"
                }
              ]
            },
            "displayCount": {
              "type": "array",
              "items": [
                {
                  "type": "integer"
                },
                {
                  "type": "integer"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "source": {
              "type": "array",
              "items": [
                {
                  "type": "string"
                },
                {
                  "type": "string"
                }
              ]
            }
          },
          "required": [
            "sequenceNumber",
            "incResolved",
            "resolved",
            "name",
            "message",
            "type",
            "displayCount",
            "source"
          ]
        },
        "summary": {
          "type": "object",
          "properties": {
            "incReviewed": {
              "type": "boolean"
            },
            "isReviewed": {
              "type": "boolean"
            }
          },
          "required": [
            "incReviewed",
            "isReviewed"
          ]
        }
      },
      "required": [
        "startTime",
        "endTime",
        "id",
        "lang",
        "sessionId",
        "metadata",
        "entity",
        "disposition",
        "manualEdits",
        "speakerVerification",
        "alerts",
        "summary"
      ]
    },
    "select": {
      "type": "array",
      "items": [
        {
          "type": "string"
        },
        {
          "type": "string"
        }
      ]
    },
    "groupBy": {
      "type": "object",
      "properties": {
        "columns": {
          "type": "array",
          "items": [
            {
              "type": "string"
            },
            {
              "type": "string"
            }
          ]
        },
        "aggregations": {
          "type": "array",
          "items": [
            {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string"
                },
                "type": {
                  "type": "string"
                },
                "column": {
                  "type": "string"
                }
              },
              "required": [
                "name",
                "type",
                "column"
              ]
            }
          ]
        }
      },
      "required": [
        "columns",
        "aggregations"
      ]
    }
  },
  "required": [
    "id",
    "type",
    "filters",
    "select",
    "groupBy"
  ]
}