Insights

Get insights

Changed on

Gets the aggregate usage insights data displayed in the Insights Dashboards.

post/rest/api/v1/insights

Request

  • Base URL: https://instance-name-be.glean.com
  • URL: https://instance-name-be.glean.com/rest/api/v1/insights
  • Auth: HTTP bearer

Query parameters

localestring

The client's preferred locale in rfc5646 format (e.g. en, ja, pt-BR). If omitted, the Accept-Language will be used. If not present or not supported, defaults to the closest match or en.

Headers

X-Glean-ActAsstring email

Email address of a user on whose behalf the request is intended to be made (should be non-empty only for global tokens).

X-Glean-Auth-Typestring

Auth type being used to access the endpoint (should be non-empty only for global tokens).

Request body

disablePerUserInsightsboolean

If true, suppresses the generation of per-user Insights in the response. Default is false.

Response

OK

Example response

{
  "gleanAssist": {
    "activityInsights": [
      {
        "user": {
          "name": "George Clooney",
          "obfuscatedId": "abc123"
        }
      }
    ]
  },
  "overviewResponse": {
    "perUserInsights": [
      {
        "person": {
          "name": "George Clooney",
          "obfuscatedId": "abc123"
        }
      }
    ]
  },
  "assistantResponse": {
    "perUserInsights": [
      {
        "person": {
          "name": "George Clooney",
          "obfuscatedId": "abc123"
        }
      }
    ]
  },
  "agentsResponse": {
    "topAgentsInsights": [
      {
        "icon": {
          "color": "#343CED",
          "key": "person_icon",
          "iconType": "GLYPH",
          "name": "user"
        },
        "owner": {
          "name": "George Clooney",
          "obfuscatedId": "abc123"
        }
      }
    ],
    "topUseCasesInsights": [
      {
        "topAgentIcon": {
          "color": "#343CED",
          "key": "person_icon",
          "iconType": "GLYPH",
          "name": "user"
        }
      }
    ],
    "agentsUsageByDepartmentInsights": [
      {
        "icon": {
          "color": "#343CED",
          "key": "person_icon",
          "iconType": "GLYPH",
          "name": "user"
        }
      }
    ],
    "agentUsersInsights": [
      {
        "person": {
          "name": "George Clooney",
          "obfuscatedId": "abc123"
        }
      }
    ],
    "agentsTimeSavedInsights": [
      {
        "icon": {
          "color": "#343CED",
          "key": "person_icon",
          "iconType": "GLYPH",
          "name": "user"
        }
      }
    ]
  },
  "mcpBreakdownResponse": {
    "usersBreakdown": [
      {
        "person": {
          "name": "George Clooney",
          "obfuscatedId": "abc123"
        }
      }
    ]
  }
}

Changes

  • cfa377371200Revision changes
    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property //////// to the response with the status

  • 3c36e7c6aa0cRevision changes
    • warning

      added the new VIDEO_TYPE enum value to the ////////////// response property for the response status

    • warning

      added the new VIDEO_TYPE enum value to the ////////////// response property for the response status

    • warning

      added the new VIDEO_TYPE enum value to the ////////////// response property for the response status

    • warning

      added the new VIDEO_TYPE enum value to the ///////////// response property for the response status

    • warning

      added the new VIDEO_TYPE enum value to the ///////////// response property for the response status

    • warning

      added the new VIDEO_TYPE enum value to the ////////////// response property for the response status

    • info

      added the new optional request property /

    • info

      added the new AUTH_METHODS enum value to the request property /

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property ///// to the response with the status