Microsoft Endpoint Configuration Management Policies API

openapi: 3.2.0
info:
  title: Microsoft Endpoint Configuration Management Intune Data Warehouse Policies API
  description: OData-based REST API that provides access to Intune reporting data in a machine-readable format. Enables building custom reports and analytics for enterprise mobile environment insights. Uses OData v4.0 protocol with standard patterns for request/response headers, status codes, HTTP methods, URL conventions, and query options. Data is sampled daily to provide a historical view of the mobile device environment.
  version: 1.0.0
  contact:
    name: Microsoft Intune Support
    url: https://learn.microsoft.com/en-us/intune/intune-service/developer/reports-nav-intune-data-warehouse
  license:
    name: Microsoft API License
    url: https://learn.microsoft.com/en-us/legal/microsoft-apis/terms-of-use
servers:
- url: https://fef.{location}.manage.microsoft.com/ReportingService/DataWarehouseFEService
  description: Intune Data Warehouse endpoint
  variables:
    location:
      default: msua06
      description: Location identifier found in the Data Warehouse API blade in the Microsoft Intune admin center.
security:
- oauth2: []
tags:
- name: Policies
  description: Policy records and compliance activities.
paths:
  /policies:
    get:
      operationId: listPolicies
      summary: Microsoft Endpoint Configuration Management List policy records
      description: Retrieve compliance and configuration policy records from the Data Warehouse.
      tags:
      - Policies
      parameters:
      - $ref: '#/components/parameters/apiVersion'
      - $ref: '#/components/parameters/top'
      - $ref: '#/components/parameters/skip'
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/select'
      responses:
        '200':
          description: Successful response returning policy records.
          content:
            application/json:
              schema:
                type: object
                properties:
                  value:
                    type: array
                    items:
                      $ref: '#/components/schemas/Policy'
  /policyDeviceActivities:
    get:
      operationId: listPolicyDeviceActivities
      summary: Microsoft Endpoint Configuration Management List policy device activities
      description: Retrieve policy device activity records showing device compliance status against policies over time.
      tags:
      - Policies
      parameters:
      - $ref: '#/components/parameters/apiVersion'
      - $ref: '#/components/parameters/top'
      - $ref: '#/components/parameters/skip'
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/select'
      - $ref: '#/components/parameters/maxhistorydays'
      responses:
        '200':
          description: Successful response returning policy device activities.
          content:
            application/json:
              schema:
                type: object
                properties:
                  value:
                    type: array
                    items:
                      $ref: '#/components/schemas/PolicyDeviceActivity'
  /policyUserActivities:
    get:
      operationId: listPolicyUserActivities
      summary: Microsoft Endpoint Configuration Management List policy user activities
      description: Retrieve policy user activity records showing user compliance status against policies over time.
      tags:
      - Policies
      parameters:
      - $ref: '#/components/parameters/apiVersion'
      - $ref: '#/components/parameters/top'
      - $ref: '#/components/parameters/skip'
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/select'
      - $ref: '#/components/parameters/maxhistorydays'
      responses:
        '200':
          description: Successful response returning policy user activities.
          content:
            application/json:
              schema:
                type: object
                properties:
                  value:
                    type: array
                    items:
                      $ref: '#/components/schemas/PolicyUserActivity'
components:
  schemas:
    PolicyUserActivity:
      type: object
      description: User compliance activity record against a specific policy.
      properties:
        dateKey:
          type: integer
          description: Date key for the activity.
        policyKey:
          type: integer
          description: Policy key reference.
        pending:
          type: integer
          description: Number of users pending compliance evaluation.
        succeeded:
          type: integer
          description: Number of users in compliance.
        failed:
          type: integer
          description: Number of users out of compliance.
        error:
          type: integer
          description: Number of users in error state.
    Policy:
      type: object
      description: Policy entity representing compliance and configuration policies.
      properties:
        policyKey:
          type: integer
          description: Unique key for the policy in the Data Warehouse.
        policyId:
          type: string
          description: Unique identifier of the policy.
        policyName:
          type: string
          description: Name of the policy.
        policyVersion:
          type: integer
          description: Version of the policy.
        isDeleted:
          type: boolean
          description: Whether the policy has been deleted.
        policyTypeKey:
          type: integer
          description: Reference to the policy type.
        policyPlatformKey:
          type: integer
          description: Reference to the platform.
    PolicyDeviceActivity:
      type: object
      description: Device compliance activity record against a specific policy.
      properties:
        dateKey:
          type: integer
          description: Date key for the activity.
        policyKey:
          type: integer
          description: Policy key reference.
        pending:
          type: integer
          description: Number of devices pending compliance evaluation.
        succeeded:
          type: integer
          description: Number of devices in compliance.
        failed:
          type: integer
          description: Number of devices out of compliance.
        error:
          type: integer
          description: Number of devices in error state.
  parameters:
    maxhistorydays:
      name: maxhistorydays
      in: query
      description: Maximum number of days of history to retrieve. Only takes effect for collections that include dateKey as part of their key property.
      schema:
        type: integer
        default: 7
    apiVersion:
      name: api-version
      in: query
      required: true
      description: API version. Use 'v1.0' for stable or 'beta' for preview features.
      schema:
        type: string
        enum:
        - v1.0
        - beta
        default: v1.0
    select:
      name: $select
      in: query
      description: Comma-separated list of properties to include.
      schema:
        type: string
    top:
      name: $top
      in: query
      description: Number of items to return.
      schema:
        type: integer
    skip:
      name: $skip
      in: query
      description: Number of items to skip.
      schema:
        type: integer
    filter:
      name: $filter
      in: query
      description: OData filter expression. Only DateKey or RowLastModifiedDateTimeUTC may be supported for filtering depending on the collection.
      schema:
        type: string
  securitySchemes:
    oauth2:
      type: oauth2
      description: OAuth 2.0 via Microsoft Entra ID. Requires Intune service administrator role or role-based access to the Intune data warehouse resource.
      flows:
        authorizationCode:
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
          tokenUrl: https://login.microsoftonline.com/common/oauth2/v2.0/token
          scopes:
            https://api.manage.microsoft.com/.default: Access Intune Data Warehouse