Get Microsoft 365 directory counts
Counts synced members and published-policy enrollment from the latest completed directory snapshot. Counts can be null while the snapshot is stale or changing.
/api/v1/marketing/microsoft-365/statsWorkspace automation for approved Dashio products. Each token is scoped to one Space and independently granted operations. Requests spend shared minute credits, and selected operation groups also share hourly quotas.
Required token scope is marketing:microsoft365:read. Scopes are independent.
This operation uses 5 credits from a shared budget of 60 credits per token and 300 per Space each UTC minute. The directory group shares 40 requests per token and 100 per Space each UTC hour.
Run these examples on a trusted server with DASHIO_API_TOKEN configured. Use a private terminal when inspecting response data. Examples send one request with a bounded timeout and do not retry automatically.
Authentication
Dashio developer token (HTTP Bearer) API authentication guide
Path parameters
None documented.
Query parameters
None documented.
Header parameters
None documented.
Request body
No content type declared
No request body schema is documented.
Responses
Headers on every response
X-Request-Idstring (uuid)OptionalServer-generated ID to include in a support request.
200
Completed-snapshot counts or a reason the counts are unavailable.
Response headers
RateLimit-LimitintegerOptionalPer-token capacity in the reported gateway window, expressed in requests of this operation. A shared Space budget also applies. Present when the request reaches the authenticated gateway. Minimum: 1.
RateLimit-RemainingintegerOptionalRequests of this operation remaining under the current token, Space and applicable operation-group quotas. Present when the request reaches the authenticated gateway. Minimum: 0.
RateLimit-ResetintegerOptionalUnix timestamp in seconds when the reported gateway quota resets. Present when the request reaches the authenticated gateway. Minimum: 0.
application/json
syncedEmployeesinteger | nullRequiredMinimum: 0.
enrolledEmployeesinteger | nullRequiredMinimum: 0.
lastSyncAtstring | null (date-time)RequiredNo field description supplied.
reasonstring | nullRequiredAllowed values: "subscription_required", "integration_disabled", "tenant_not_connected", "sync_required", "sync_in_progress", "directory_stale", "count_limit", "invalid_policy", "revision_conflict", null.
400
The request fields, selectors or resource identifiers are invalid.
application/json
statusCodeintegerRequiredMinimum: 400. Maximum: 599.
statusMessagestringOptionalA safe explanation suitable for display.
dataobjectRequiredNo field description supplied.
401
A valid Developer API bearer token is required.
Response headers
WWW-AuthenticatestringOptionalBearer authentication challenge. A rejected token can include the invalid_token error.
application/json
Uses the same response body schema as HTTP 400.
402
An active eligible Marketing entitlement is required.
application/json
Uses the same response body schema as HTTP 400.
403
The token scope, current Space role or plan allowance does not permit this operation.
application/json
Uses the same response body schema as HTTP 400.
404
The resource was not found in the token Space or the operation is unavailable.
application/json
Uses the same response body schema as HTTP 400.
429
The request rate limit was reached. Edge traffic limits can also return 429.
Response headers
RateLimit-LimitintegerOptionalPer-token capacity in the reported gateway window, expressed in requests of this operation. A shared Space budget also applies. Present when the request reaches the authenticated gateway. Minimum: 1.
RateLimit-RemainingintegerOptionalRequests of this operation remaining under the current token, Space and applicable operation-group quotas. Present when the request reaches the authenticated gateway. Minimum: 0.
RateLimit-ResetintegerOptionalUnix timestamp in seconds when the reported gateway quota resets. Present when the request reaches the authenticated gateway. Minimum: 0.
Retry-AfterintegerOptionalSeconds to wait before retrying, when the limiting policy supplies a retry time. Minimum: 1.
application/json
Uses the same response body schema as HTTP 400.
503
The operation is temporarily unavailable.
application/json
Uses the same response body schema as HTTP 400.
Was this helpful?