List readingCoachPassages

2025-07-23

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Get a list of Reading Coach passages that were practiced by a student.

This API is available in the following national cloud deployments.

Global service	US Government L4	US Government L5 (DOD)	China operated by 21Vianet
✅	❌	❌	❌

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

Permission type	Least privileged permissions	Higher privileged permissions
Delegated (work or school account)	Not supported.	Not supported.
Delegated (personal Microsoft account)	Not supported.	Not supported.
Application	EduReports-Reading.ReadAnonymous.All	EduReports-Reading.Read.All

HTTP request

GET /education/reports/readingCoachPassages

Optional query parameters

This method supports the $top, $filter, $count, $skipToken, and $select OData query parameters to help customize the response. For general information, see OData query parameters.

Request headers

Name	Description
Authorization	Bearer {token}. Required. Learn more about authentication and authorization.

Request body

Don't supply a request body for this method.

Response

If successful, this method returns a 200 OK response code and a collection of readingCoachPassage objects in the response body.

Examples

Example 1: Get a list of the Reading Coach passages from the last 24 hours

The following example shows how to get a list of the Reading Coach passages from the last 24 hours.

Request

The following example shows a request.

GET https://graph.microsoft.com/beta/education/reports/readingCoachPassages


// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Education.Reports.ReadingCoachPassages.GetAsync();

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.



// Code snippets are only available for the latest major version. Current major version is $v0.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
	  //other-imports
)


// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
readingCoachPassages, err := graphClient.Education().Reports().ReadingCoachPassages().Get(context.Background(), nil)

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

ReadingCoachPassageCollectionResponse result = graphClient.education().reports().readingCoachPassages().get();

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


const options = {
	authProvider,
};

const client = Client.init(options);

let readingCoachPassages = await client.api('/education/reports/readingCoachPassages')
	.version('beta')
	.get();

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


<?php
use Microsoft\Graph\Beta\GraphServiceClient;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);


$result = $graphServiceClient->education()->reports()->readingCoachPassages()->get()->wait();

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python

result = await graph_client.education.reports.reading_coach_passages.get()

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Response

The following example shows the default response from the last 24 hours.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 200 OK
Content-Type: application/json

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#education/reports/readingCoachPassages",
  "value": [
    {
      "practicedAtDateTime": "2025-06-25T14:51:31.0663974Z",
      "studentId": "27a9716d-05aa-4aaa-ae18-9fc10318a03d",
      "practiceWords": [
        "science",
        "experiment",
        "laboratory",
        "hypothesis",
        "observation"
      ],
      "wordsPerMinute": 55.5,
      "wordsAccuracyPercentage": 92.0,
      "timeSpentReadingInSeconds": 165.75,
      "languageTag": "en-US",
      "storyType": "userProvided",
      "isReadingCompleted": true
    },
    {
      "practicedAtDateTime": "2025-06-25T12:51:31.0663974Z",
      "studentId": "27a9716d-05aa-4aaa-ae18-9fc10318a03d",
      "practiceWords": [
        "tortoise",
        "experiment"
      ],
      "wordsPerMinute": 52.5,
      "wordsAccuracyPercentage": 94.5,
      "timeSpentReadingInSeconds": 180.5,
      "languageTag": "en-US",
      "storyType": "aiGenerated",
      "isReadingCompleted": true
    }
  ]
}

Example 2: Get a list of the Reading Coach passages for a specific date using $filter

The following example shows how to get the Reading Coach passages for a specific date using the $filter query parameter. The requested time range must be 24 hours or shorter.

Request

The following example shows a request.

GET https://graph.microsoft.com/beta/education/reports/readingCoachPassages?$filter=practicedAtDateTime gt 2025-06-22T00:00:00Z and practicedAtDateTime lt 2025-06-23T00:00:00Z


// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Education.Reports.ReadingCoachPassages.GetAsync((requestConfiguration) =>
{
	requestConfiguration.QueryParameters.Filter = "practicedAtDateTime gt 2025-06-22T00:00:00Z and practicedAtDateTime lt 2025-06-23T00:00:00Z";
});

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.



// Code snippets are only available for the latest major version. Current major version is $v0.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
	  grapheducation "github.com/microsoftgraph/msgraph-beta-sdk-go/education"
	  //other-imports
)


requestFilter := "practicedAtDateTime gt 2025-06-22T00:00:00Z and practicedAtDateTime lt 2025-06-23T00:00:00Z"

requestParameters := &grapheducation.ReportsReadingCoachPassagesRequestBuilderGetQueryParameters{
	Filter: &requestFilter,
}
configuration := &grapheducation.ReportsReadingCoachPassagesRequestBuilderGetRequestConfiguration{
	QueryParameters: requestParameters,
}

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
readingCoachPassages, err := graphClient.Education().Reports().ReadingCoachPassages().Get(context.Background(), configuration)

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

ReadingCoachPassageCollectionResponse result = graphClient.education().reports().readingCoachPassages().get(requestConfiguration -> {
	requestConfiguration.queryParameters.filter = "practicedAtDateTime gt 2025-06-22T00:00:00Z and practicedAtDateTime lt 2025-06-23T00:00:00Z";
});

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


const options = {
	authProvider,
};

const client = Client.init(options);

let readingCoachPassages = await client.api('/education/reports/readingCoachPassages')
	.version('beta')
	.filter('practicedAtDateTime gt 2025-06-22T00:00:00Z and practicedAtDateTime lt 2025-06-23T00:00:00Z')
	.get();

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Education\Reports\ReadingCoachPassages\ReadingCoachPassagesRequestBuilderGetRequestConfiguration;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestConfiguration = new ReadingCoachPassagesRequestBuilderGetRequestConfiguration();
$queryParameters = ReadingCoachPassagesRequestBuilderGetRequestConfiguration::createQueryParameters();
$queryParameters->filter = "practicedAtDateTime gt 2025-06-22T00:00:00Z and practicedAtDateTime lt 2025-06-23T00:00:00Z";
$requestConfiguration->queryParameters = $queryParameters;


$result = $graphServiceClient->education()->reports()->readingCoachPassages()->get($requestConfiguration)->wait();

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.education.reports.reading_coach_passages.reading_coach_passages_request_builder import ReadingCoachPassagesRequestBuilder
from kiota_abstractions.base_request_configuration import RequestConfiguration
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
query_params = ReadingCoachPassagesRequestBuilder.ReadingCoachPassagesRequestBuilderGetQueryParameters(
		filter = "practicedAtDateTime gt 2025-06-22T00:00:00Z and practicedAtDateTime lt 2025-06-23T00:00:00Z",
)

request_configuration = RequestConfiguration(
query_parameters = query_params,
)

result = await graph_client.education.reports.reading_coach_passages.get(request_configuration = request_configuration)

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 200 OK
Content-Type: application/json

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#education/reports/readingCoachPassages",
  "value": [
    {
      "practicedAtDateTime": "2025-06-22T14:51:31.0663974Z",
      "studentId": "27a9716d-05aa-4aaa-ae18-9fc10318a03d",
      "practiceWords": [
        "science",
        "experiment",
        "laboratory",
        "hypothesis",
        "observation"
      ],
      "wordsPerMinute": 55.5,
      "wordsAccuracyPercentage": 92.0,
      "timeSpentReadingInSeconds": 165.75,
      "languageTag": "en-US",
      "storyType": "userProvided",
      "isReadingCompleted": true
    },
    {
      "practicedAtDateTime": "2025-06-22T12:51:31.0663974Z",
      "studentId": "27a9716d-05aa-4aaa-ae18-9fc10318a03d",
      "practiceWords": [
        "tortoise",
        "experiment"
      ],
      "wordsPerMinute": 52.5,
      "wordsAccuracyPercentage": 94.5,
      "timeSpentReadingInSeconds": 180.5,
      "languageTag": "en-US",
      "storyType": "aiGenerated",
      "isReadingCompleted": true
    }
  ]
}

Share via

List readingCoachPassages

Permissions

HTTP request

Optional query parameters

Request headers

Request body

Response

Examples

Example 1: Get a list of the Reading Coach passages from the last 24 hours

Request

Response

Example 2: Get a list of the Reading Coach passages for a specific date using $filter

Request

Response

Feedback

Additional resources