Skip to main content
POST
Monitor Copilot Responses

Overview

The Microsoft Copilot endpoint extracts structured data from Microsoft Copilot with shopping cards for product tracking. Useful for development tools, Microsoft ecosystem research, and enterprise-focused queries.
Web search enabledThis endpoint uses Copilot’s default interface, which always performs web searches for all requests to provide real-time information with source citations.

Request parameters

Uses common parameters. Endpoint-specific options:
  • include.markdown (boolean): Include markdown-formatted response. Defaults to false
  • include.rawResponse (boolean): Include raw streaming response events. Defaults to false

Response objects

The response includes the following sections. See each subpage for the full schema and examples.

Response schema

Includes common response fields plus:

Authorizations

Authorization
string
header
required

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

Body

application/json

Request parameters for monitoring Copilot responses

prompt
string
required

The prompt to send to Copilot

Required string length: 1 - 10000
Example:

"What are the best laptops for programming?"

country
string
required

Country/region code for localized response

Example:

"US"

include
object

Optional flags for including additional response formats

state
string

State code for sub-country geo-targeting (e.g., "CA"). Only valid with country "US".

Required string length: 2
Pattern: ^[A-Z]{2}$
Example:

"CA"

Response

successful Copilot monitoring response

success
boolean
required
Example:

true

result
object
required

Copilot response data