curl --request POST \
  --url https://{domain}-be.glean.com/rest/api/v1/insights \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "categories": [
    "AI"
  ],
  "departments": [
    "<string>"
  ],
  "dayRange": {
    "minDaysFromNow": 123,
    "maxDaysFromNow": 123,
    "start": {
      "epochSeconds": 123,
      "daysFromNow": 123
    },
    "end": {
      "epochSeconds": 123,
      "daysFromNow": 123
    }
  },
  "aiAppRequestOptions": {
    "aiAppIds": [
      "<string>"
    ]
  },
  "assistantActivityTypes": [
    "GLEAN_CHAT"
  ],
  "disablePerUserInsights": true
}'
{
  "timeseries": [
    {
      "label": "<string>",
      "countInfo": [
        {
          "count": 123,
          "period": {
            "minDaysFromNow": 123,
            "maxDaysFromNow": 123,
            "start": {
              "epochSeconds": 123,
              "daysFromNow": 123
            },
            "end": {
              "epochSeconds": 123,
              "daysFromNow": 123
            }
          },
          "org": "<string>"
        }
      ]
    }
  ],
  "users": {
    "lastLogTimestamp": 123,
    "activityInsights": [
      {
        "user": {
          "name": "George Clooney",
          "obfuscatedId": "abc123"
        },
        "activity": "ALL",
        "lastActivityTimestamp": 123,
        "activityCount": {
          "count": 123,
          "period": {
            "minDaysFromNow": 123,
            "maxDaysFromNow": 123,
            "start": {
              "epochSeconds": 123,
              "daysFromNow": 123
            },
            "end": {
              "epochSeconds": 123,
              "daysFromNow": 123
            }
          },
          "org": "<string>"
        },
        "activeDayCount": {
          "count": 123,
          "period": {
            "minDaysFromNow": 123,
            "maxDaysFromNow": 123,
            "start": {
              "epochSeconds": 123,
              "daysFromNow": 123
            },
            "end": {
              "epochSeconds": 123,
              "daysFromNow": 123
            }
          },
          "org": "<string>"
        }
      }
    ],
    "inactiveInsights": [
      {
        "user": {
          "name": "George Clooney",
          "obfuscatedId": "abc123"
        },
        "activity": "ALL",
        "lastActivityTimestamp": 123,
        "activityCount": {
          "count": 123,
          "period": {
            "minDaysFromNow": 123,
            "maxDaysFromNow": 123,
            "start": {
              "epochSeconds": 123,
              "daysFromNow": 123
            },
            "end": {
              "epochSeconds": 123,
              "daysFromNow": 123
            }
          },
          "org": "<string>"
        },
        "activeDayCount": {
          "count": 123,
          "period": {
            "minDaysFromNow": 123,
            "maxDaysFromNow": 123,
            "start": {
              "epochSeconds": 123,
              "daysFromNow": 123
            },
            "end": {
              "epochSeconds": 123,
              "daysFromNow": 123
            }
          },
          "org": "<string>"
        }
      }
    ],
    "totalTeammates": 123,
    "totalActiveUsers": 123,
    "departments": [
      "<string>"
    ]
  },
  "content": {
    "lastLogTimestamp": 123,
    "documentInsights": [
      {
        "document": {
          "id": "<string>",
          "datasource": "<string>",
          "connectorType": "API_CRAWL",
          "docType": "<string>",
          "content": {
            "fullTextList": [
              "<string>"
            ]
          },
          "containerDocument": {},
          "parentDocument": {},
          "title": "<string>",
          "url": "<string>",
          "metadata": {
            "container": "container",
            "parentId": "JIRA_EN-1337",
            "createTime": "2000-01-23T04:56:07.000Z",
            "datasource": "datasource",
            "author": {
              "name": "name"
            },
            "documentId": "documentId",
            "updateTime": "2000-01-23T04:56:07.000Z",
            "mimeType": "mimeType",
            "objectType": "Feature Request",
            "components": [
              "Backend",
              "Networking"
            ],
            "status": [
              "Done"
            ],
            "customData": {
              "someCustomField": "someCustomValue"
            }
          },
          "sections": [
            {
              "title": "<string>",
              "url": "<string>"
            }
          ]
        },
        "viewCount": {
          "count": 123,
          "period": {
            "minDaysFromNow": 123,
            "maxDaysFromNow": 123,
            "start": {
              "epochSeconds": 123,
              "daysFromNow": 123
            },
            "end": {
              "epochSeconds": 123,
              "daysFromNow": 123
            }
          },
          "org": "<string>"
        },
        "visitorCount": {
          "count": 123,
          "period": {
            "minDaysFromNow": 123,
            "maxDaysFromNow": 123,
            "start": {
              "epochSeconds": 123,
              "daysFromNow": 123
            },
            "end": {
              "epochSeconds": 123,
              "daysFromNow": 123
            }
          },
          "org": "<string>"
        }
      }
    ],
    "departments": [
      "<string>"
    ],
    "minDepartmentSizeThreshold": 123,
    "minVisitorThreshold": 123
  },
  "queries": {
    "lastLogTimestamp": 123,
    "queryInsights": [
      {
        "query": "<string>",
        "searchCount": {
          "count": 123,
          "period": {
            "minDaysFromNow": 123,
            "maxDaysFromNow": 123,
            "start": {
              "epochSeconds": 123,
              "daysFromNow": 123
            },
            "end": {
              "epochSeconds": 123,
              "daysFromNow": 123
            }
          },
          "org": "<string>"
        },
        "searchorCount": {
          "count": 123,
          "period": {
            "minDaysFromNow": 123,
            "maxDaysFromNow": 123,
            "start": {
              "epochSeconds": 123,
              "daysFromNow": 123
            },
            "end": {
              "epochSeconds": 123,
              "daysFromNow": 123
            }
          },
          "org": "<string>"
        },
        "searchWithClickCount": {
          "count": 123,
          "period": {
            "minDaysFromNow": 123,
            "maxDaysFromNow": 123,
            "start": {
              "epochSeconds": 123,
              "daysFromNow": 123
            },
            "end": {
              "epochSeconds": 123,
              "daysFromNow": 123
            }
          },
          "org": "<string>"
        },
        "clickCount": {
          "count": 123,
          "period": {
            "minDaysFromNow": 123,
            "maxDaysFromNow": 123,
            "start": {
              "epochSeconds": 123,
              "daysFromNow": 123
            },
            "end": {
              "epochSeconds": 123,
              "daysFromNow": 123
            }
          },
          "org": "<string>"
        },
        "similarQueries": [
          {}
        ]
      }
    ],
    "lowPerformingQueryInsights": [
      {
        "query": "<string>",
        "searchCount": {
          "count": 123,
          "period": {
            "minDaysFromNow": 123,
            "maxDaysFromNow": 123,
            "start": {
              "epochSeconds": 123,
              "daysFromNow": 123
            },
            "end": {
              "epochSeconds": 123,
              "daysFromNow": 123
            }
          },
          "org": "<string>"
        },
        "searchorCount": {
          "count": 123,
          "period": {
            "minDaysFromNow": 123,
            "maxDaysFromNow": 123,
            "start": {
              "epochSeconds": 123,
              "daysFromNow": 123
            },
            "end": {
              "epochSeconds": 123,
              "daysFromNow": 123
            }
          },
          "org": "<string>"
        },
        "searchWithClickCount": {
          "count": 123,
          "period": {
            "minDaysFromNow": 123,
            "maxDaysFromNow": 123,
            "start": {
              "epochSeconds": 123,
              "daysFromNow": 123
            },
            "end": {
              "epochSeconds": 123,
              "daysFromNow": 123
            }
          },
          "org": "<string>"
        },
        "clickCount": {
          "count": 123,
          "period": {
            "minDaysFromNow": 123,
            "maxDaysFromNow": 123,
            "start": {
              "epochSeconds": 123,
              "daysFromNow": 123
            },
            "end": {
              "epochSeconds": 123,
              "daysFromNow": 123
            }
          },
          "org": "<string>"
        },
        "similarQueries": [
          {}
        ]
      }
    ],
    "departments": [
      "<string>"
    ],
    "minVisitorThreshold": 123
  },
  "collections": {
    "lastLogTimestamp": 123,
    "documentInsights": [
      {
        "document": {
          "id": "<string>",
          "datasource": "<string>",
          "connectorType": "API_CRAWL",
          "docType": "<string>",
          "content": {
            "fullTextList": [
              "<string>"
            ]
          },
          "containerDocument": {},
          "parentDocument": {},
          "title": "<string>",
          "url": "<string>",
          "metadata": {
            "container": "container",
            "parentId": "JIRA_EN-1337",
            "createTime": "2000-01-23T04:56:07.000Z",
            "datasource": "datasource",
            "author": {
              "name": "name"
            },
            "documentId": "documentId",
            "updateTime": "2000-01-23T04:56:07.000Z",
            "mimeType": "mimeType",
            "objectType": "Feature Request",
            "components": [
              "Backend",
              "Networking"
            ],
            "status": [
              "Done"
            ],
            "customData": {
              "someCustomField": "someCustomValue"
            }
          },
          "sections": [
            {
              "title": "<string>",
              "url": "<string>"
            }
          ]
        },
        "viewCount": {
          "count": 123,
          "period": {
            "minDaysFromNow": 123,
            "maxDaysFromNow": 123,
            "start": {
              "epochSeconds": 123,
              "daysFromNow": 123
            },
            "end": {
              "epochSeconds": 123,
              "daysFromNow": 123
            }
          },
          "org": "<string>"
        },
        "visitorCount": {
          "count": 123,
          "period": {
            "minDaysFromNow": 123,
            "maxDaysFromNow": 123,
            "start": {
              "epochSeconds": 123,
              "daysFromNow": 123
            },
            "end": {
              "epochSeconds": 123,
              "daysFromNow": 123
            }
          },
          "org": "<string>"
        }
      }
    ],
    "departments": [
      "<string>"
    ],
    "minDepartmentSizeThreshold": 123,
    "minVisitorThreshold": 123
  },
  "collectionsV2": {
    "lastLogTimestamp": 123,
    "documentInsights": [
      {
        "document": {
          "id": "<string>",
          "datasource": "<string>",
          "connectorType": "API_CRAWL",
          "docType": "<string>",
          "content": {
            "fullTextList": [
              "<string>"
            ]
          },
          "containerDocument": {},
          "parentDocument": {},
          "title": "<string>",
          "url": "<string>",
          "metadata": {
            "container": "container",
            "parentId": "JIRA_EN-1337",
            "createTime": "2000-01-23T04:56:07.000Z",
            "datasource": "datasource",
            "author": {
              "name": "name"
            },
            "documentId": "documentId",
            "updateTime": "2000-01-23T04:56:07.000Z",
            "mimeType": "mimeType",
            "objectType": "Feature Request",
            "components": [
              "Backend",
              "Networking"
            ],
            "status": [
              "Done"
            ],
            "customData": {
              "someCustomField": "someCustomValue"
            }
          },
          "sections": [
            {
              "title": "<string>",
              "url": "<string>"
            }
          ]
        },
        "viewCount": {
          "count": 123,
          "period": {
            "minDaysFromNow": 123,
            "maxDaysFromNow": 123,
            "start": {
              "epochSeconds": 123,
              "daysFromNow": 123
            },
            "end": {
              "epochSeconds": 123,
              "daysFromNow": 123
            }
          },
          "org": "<string>"
        },
        "visitorCount": {
          "count": 123,
          "period": {
            "minDaysFromNow": 123,
            "maxDaysFromNow": 123,
            "start": {
              "epochSeconds": 123,
              "daysFromNow": 123
            },
            "end": {
              "epochSeconds": 123,
              "daysFromNow": 123
            }
          },
          "org": "<string>"
        }
      }
    ],
    "departments": [
      "<string>"
    ],
    "minDepartmentSizeThreshold": 123,
    "minVisitorThreshold": 123
  },
  "shortcuts": {
    "lastLogTimestamp": 123,
    "shortcutInsights": [
      {
        "shortcut": {
          "id": 123,
          "inputAlias": "<string>",
          "destinationUrl": "<string>",
          "destinationDocumentId": "<string>",
          "description": "<string>",
          "unlisted": true,
          "urlTemplate": "<string>",
          "addedRoles": [
            {
              "sourceDocumentSpec": {
                "url": "<string>"
              },
              "person": {
                "name": "George Clooney",
                "obfuscatedId": "abc123"
              },
              "group": {
                "type": "DEPARTMENT",
                "id": "<string>",
                "name": "<string>"
              },
              "role": "OWNER"
            }
          ],
          "removedRoles": [
            {
              "sourceDocumentSpec": {
                "url": "<string>"
              },
              "person": {
                "name": "George Clooney",
                "obfuscatedId": "abc123"
              },
              "group": {
                "type": "DEPARTMENT",
                "id": "<string>",
                "name": "<string>"
              },
              "role": "OWNER"
            }
          ],
          "permissions": {
            "write": {
              "scopeType": "GLOBAL",
              "create": true,
              "update": true,
              "delete": true
            }
          },
          "createdBy": {
            "name": "George Clooney",
            "obfuscatedId": "abc123"
          },
          "createTime": "2023-11-07T05:31:56Z",
          "updatedBy": {
            "name": "George Clooney",
            "obfuscatedId": "abc123"
          },
          "updateTime": "2023-11-07T05:31:56Z",
          "destinationDocument": {},
          "intermediateUrl": "<string>",
          "viewPrefix": "<string>",
          "isExternal": true,
          "editUrl": "<string>",
          "alias": "<string>",
          "title": "<string>",
          "roles": [
            {
              "sourceDocumentSpec": {
                "url": "<string>"
              },
              "person": {
                "name": "George Clooney",
                "obfuscatedId": "abc123"
              },
              "group": {
                "type": "DEPARTMENT",
                "id": "<string>",
                "name": "<string>"
              },
              "role": "OWNER"
            }
          ]
        },
        "visitCount": {
          "count": 123,
          "period": {
            "minDaysFromNow": 123,
            "maxDaysFromNow": 123,
            "start": {
              "epochSeconds": 123,
              "daysFromNow": 123
            },
            "end": {
              "epochSeconds": 123,
              "daysFromNow": 123
            }
          },
          "org": "<string>"
        },
        "visitorCount": {
          "count": 123,
          "period": {
            "minDaysFromNow": 123,
            "maxDaysFromNow": 123,
            "start": {
              "epochSeconds": 123,
              "daysFromNow": 123
            },
            "end": {
              "epochSeconds": 123,
              "daysFromNow": 123
            }
          },
          "org": "<string>"
        }
      }
    ],
    "departments": [
      "<string>"
    ],
    "minVisitorThreshold": 123
  },
  "announcements": {
    "lastLogTimestamp": 123,
    "documentInsights": [
      {
        "document": {
          "id": "<string>",
          "datasource": "<string>",
          "connectorType": "API_CRAWL",
          "docType": "<string>",
          "content": {
            "fullTextList": [
              "<string>"
            ]
          },
          "containerDocument": {},
          "parentDocument": {},
          "title": "<string>",
          "url": "<string>",
          "metadata": {
            "container": "container",
            "parentId": "JIRA_EN-1337",
            "createTime": "2000-01-23T04:56:07.000Z",
            "datasource": "datasource",
            "author": {
              "name": "name"
            },
            "documentId": "documentId",
            "updateTime": "2000-01-23T04:56:07.000Z",
            "mimeType": "mimeType",
            "objectType": "Feature Request",
            "components": [
              "Backend",
              "Networking"
            ],
            "status": [
              "Done"
            ],
            "customData": {
              "someCustomField": "someCustomValue"
            }
          },
          "sections": [
            {
              "title": "<string>",
              "url": "<string>"
            }
          ]
        },
        "viewCount": {
          "count": 123,
          "period": {
            "minDaysFromNow": 123,
            "maxDaysFromNow": 123,
            "start": {
              "epochSeconds": 123,
              "daysFromNow": 123
            },
            "end": {
              "epochSeconds": 123,
              "daysFromNow": 123
            }
          },
          "org": "<string>"
        },
        "visitorCount": {
          "count": 123,
          "period": {
            "minDaysFromNow": 123,
            "maxDaysFromNow": 123,
            "start": {
              "epochSeconds": 123,
              "daysFromNow": 123
            },
            "end": {
              "epochSeconds": 123,
              "daysFromNow": 123
            }
          },
          "org": "<string>"
        }
      }
    ],
    "departments": [
      "<string>"
    ],
    "minDepartmentSizeThreshold": 123,
    "minVisitorThreshold": 123
  },
  "answers": {
    "lastLogTimestamp": 123,
    "documentInsights": [
      {
        "document": {
          "id": "<string>",
          "datasource": "<string>",
          "connectorType": "API_CRAWL",
          "docType": "<string>",
          "content": {
            "fullTextList": [
              "<string>"
            ]
          },
          "containerDocument": {},
          "parentDocument": {},
          "title": "<string>",
          "url": "<string>",
          "metadata": {
            "container": "container",
            "parentId": "JIRA_EN-1337",
            "createTime": "2000-01-23T04:56:07.000Z",
            "datasource": "datasource",
            "author": {
              "name": "name"
            },
            "documentId": "documentId",
            "updateTime": "2000-01-23T04:56:07.000Z",
            "mimeType": "mimeType",
            "objectType": "Feature Request",
            "components": [
              "Backend",
              "Networking"
            ],
            "status": [
              "Done"
            ],
            "customData": {
              "someCustomField": "someCustomValue"
            }
          },
          "sections": [
            {
              "title": "<string>",
              "url": "<string>"
            }
          ]
        },
        "viewCount": {
          "count": 123,
          "period": {
            "minDaysFromNow": 123,
            "maxDaysFromNow": 123,
            "start": {
              "epochSeconds": 123,
              "daysFromNow": 123
            },
            "end": {
              "epochSeconds": 123,
              "daysFromNow": 123
            }
          },
          "org": "<string>"
        },
        "visitorCount": {
          "count": 123,
          "period": {
            "minDaysFromNow": 123,
            "maxDaysFromNow": 123,
            "start": {
              "epochSeconds": 123,
              "daysFromNow": 123
            },
            "end": {
              "epochSeconds": 123,
              "daysFromNow": 123
            }
          },
          "org": "<string>"
        }
      }
    ],
    "departments": [
      "<string>"
    ],
    "minDepartmentSizeThreshold": 123,
    "minVisitorThreshold": 123
  },
  "ai": {
    "lastLogTimestamp": 123,
    "assistantInsights": [
      {
        "user": {
          "name": "George Clooney",
          "obfuscatedId": "abc123"
        },
        "activity": "ALL",
        "lastActivityTimestamp": 123,
        "activityCount": {
          "count": 123,
          "period": {
            "minDaysFromNow": 123,
            "maxDaysFromNow": 123,
            "start": {
              "epochSeconds": 123,
              "daysFromNow": 123
            },
            "end": {
              "epochSeconds": 123,
              "daysFromNow": 123
            }
          },
          "org": "<string>"
        },
        "activeDayCount": {
          "count": 123,
          "period": {
            "minDaysFromNow": 123,
            "maxDaysFromNow": 123,
            "start": {
              "epochSeconds": 123,
              "daysFromNow": 123
            },
            "end": {
              "epochSeconds": 123,
              "daysFromNow": 123
            }
          },
          "org": "<string>"
        }
      }
    ],
    "totalActiveAssistantUsers": 123,
    "totalChatMessages": 123,
    "totalAiSummarizations": 123,
    "totalAiAnswers": 123,
    "totalUpvotes": 123,
    "totalDownvotes": 123,
    "totalGleanbotResponses": 123,
    "totalGleanbotResponsesShared": 123,
    "totalGleanbotResponsesNotHelpful": 123,
    "departments": [
      "<string>"
    ]
  },
  "aiApps": {
    "lastLogTimestamp": 123,
    "aiAppInsights": [
      {
        "user": {
          "name": "George Clooney",
          "obfuscatedId": "abc123"
        },
        "activity": "ALL",
        "lastActivityTimestamp": 123,
        "activityCount": {
          "count": 123,
          "period": {
            "minDaysFromNow": 123,
            "maxDaysFromNow": 123,
            "start": {
              "epochSeconds": 123,
              "daysFromNow": 123
            },
            "end": {
              "epochSeconds": 123,
              "daysFromNow": 123
            }
          },
          "org": "<string>"
        },
        "activeDayCount": {
          "count": 123,
          "period": {
            "minDaysFromNow": 123,
            "maxDaysFromNow": 123,
            "start": {
              "epochSeconds": 123,
              "daysFromNow": 123
            },
            "end": {
              "epochSeconds": 123,
              "daysFromNow": 123
            }
          },
          "org": "<string>"
        }
      }
    ],
    "totalActiveUsers": 123,
    "actionCounts": {
      "totalSlackbotResponses": 123,
      "totalSlackbotResponsesShared": 123,
      "totalSlackbotResponsesNotHelpful": 123,
      "totalChatMessages": 123,
      "totalUpvotes": 123,
      "totalDownvotes": 123
    },
    "departments": [
      "<string>"
    ]
  },
  "gleanAssist": {
    "lastLogTimestamp": 123,
    "activityInsights": [
      {
        "user": {
          "name": "George Clooney",
          "obfuscatedId": "abc123"
        },
        "activity": "ALL",
        "lastActivityTimestamp": 123,
        "activityCount": {
          "count": 123,
          "period": {
            "minDaysFromNow": 123,
            "maxDaysFromNow": 123,
            "start": {
              "epochSeconds": 123,
              "daysFromNow": 123
            },
            "end": {
              "epochSeconds": 123,
              "daysFromNow": 123
            }
          },
          "org": "<string>"
        },
        "activeDayCount": {
          "count": 123,
          "period": {
            "minDaysFromNow": 123,
            "maxDaysFromNow": 123,
            "start": {
              "epochSeconds": 123,
              "daysFromNow": 123
            },
            "end": {
              "epochSeconds": 123,
              "daysFromNow": 123
            }
          },
          "org": "<string>"
        }
      }
    ],
    "totalActiveUsers": 123,
    "datasourceInstances": [
      "<string>"
    ],
    "departments": [
      "<string>"
    ]
  },
  "departments": [
    "<string>"
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Scio-Actas
string

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-Type
string

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

Body

application/json
Includes request params for insights dashboard data.
categories
enum<string>[]
required

Categories of data requested. Request can include single or multiple types.

Available options:
AI,
AI_APPS,
ANNOUNCEMENTS,
ANSWERS,
COLLECTIONS,
CONTENT,
GLEAN_ASSIST,
QUERIES,
SHORTCUTS,
USERS
assistantActivityTypes
enum<string>[]

Types of activity that should count in the definition of an Assistant Active User. Affects only insights for AI category.

Available options:
GLEAN_CHAT,
AI_SUMMARY,
AI_ANSWER,
GLEANBOT_RESPONSE
disablePerUserInsights
boolean

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

departments
string[]

Departments that the data is requested for. If this is empty, corresponds to whole company.

dayRange
object
aiAppRequestOptions
object

Response

200
application/json
OK
timeseries
object[]

List of timeseries to make charts (if applicable).

users
object
content
object
queries
object
collections
object
collectionsV2
object
shortcuts
object
announcements
object
answers
object
ai
object
aiApps
object
gleanAssist
object
departments
string[]

list of all departments.