circle-exclamation
This documentation is currently under development. Certain sections are not yet complete and will be added shortly.

Insights

Execute analytics query

post
/api/{tenantId}/insights/query

Runs a custom analytics query and returns results in tabular format.

Authorization

Requires Insights.Read scope.

Rate Limiting

Limited to 60 requests per interval to protect analytics infrastructure.

Query Language

Typically uses Kusto Query Language (KQL) syntax:

Passes
| where timestamp > ago(7d)
| summarize count() by passType
| order by count_ desc

Parameters

Supports parameterized queries for security and reusability:

{
  "query": "Events | where Name == name | take 100",
  "parameters": { "name": "Pass:Installed" }
}

Use Cases

  • Custom dashboards

  • Business intelligence reports

  • Data exports

  • Trend analysis

Performance

  • Query timeout: Configurable per tenant

  • Result limits: May be enforced

  • Caching: Not automatic - implement client-side if needed

chevron-right
lockRequired scopes
This endpoint requires the following scopes:
Authorizations
OAuth2implicitRequired
Authorization URL:
Path parameters
tenantIdstringRequired
Body
querystring · nullableRequired
parametersobject · nullableOptional
optionsobjectOptional
Responses
chevron-right
200

Query executed successfully

columnsstring[] · nullableOptional
post
/api/{tenantId}/insights/query

Last updated