Extract Microsoft Copilot

Monitor Copilot Responses

curl --request POST \
  --url https://api.cloro.dev/v1/monitor/copilot \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "prompt": "What are the best laptops for programming?",
  "country": "US",
  "include": {
    "html": false,
    "markdown": false,
    "rawResponse": false
  }
}
'

{
  "success": true,
  "result": {
    "text": "As an AI assistant, I can help you find great laptops for programming...",
    "html": "https://storage.cloro.dev/results/c45a5081-808d-4ed3-9c86-e4baf16c8ab8/page-1.html",
    "sources": [
      {
        "position": 1,
        "url": "https://docs.microsoft.com/",
        "label": "Microsoft Docs",
        "description": "Official development documentation"
      }
    ],
    "shoppingCards": [
      {
        "type": "shoppingProducts",
        "layout": "Carousel",
        "products": [
          {
            "product": {
              "id": "<string>",
              "groupId": "<string>",
              "brandGroupId": "<string>"
            },
            "offerId": "<string>",
            "url": "<string>",
            "name": "<string>",
            "description": "<string>",
            "images": [
              {
                "title": "<string>",
                "url": "<string>"
              }
            ],
            "specifications": [
              {
                "displayName": "<string>",
                "values": [
                  "<string>"
                ]
              }
            ],
            "tags": [
              "<string>"
            ],
            "price": {
              "amount": 123,
              "currency": "<string>",
              "currencySymbol": "<string>"
            },
            "seller": "<string>",
            "sellerLogoUrl": "<string>",
            "brandName": "<string>",
            "rating": {
              "value": 123,
              "count": 123
            },
            "canTrackPrice": true
          }
        ]
      }
    ],
    "markdown": "As an AI assistant, I can help you find great laptops for programming..."
  }
}

POST

monitor

copilot

Monitor Copilot Responses

curl --request POST \
  --url https://api.cloro.dev/v1/monitor/copilot \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "prompt": "What are the best laptops for programming?",
  "country": "US",
  "include": {
    "html": false,
    "markdown": false,
    "rawResponse": false
  }
}
'

{
  "success": true,
  "result": {
    "text": "As an AI assistant, I can help you find great laptops for programming...",
    "html": "https://storage.cloro.dev/results/c45a5081-808d-4ed3-9c86-e4baf16c8ab8/page-1.html",
    "sources": [
      {
        "position": 1,
        "url": "https://docs.microsoft.com/",
        "label": "Microsoft Docs",
        "description": "Official development documentation"
      }
    ],
    "shoppingCards": [
      {
        "type": "shoppingProducts",
        "layout": "Carousel",
        "products": [
          {
            "product": {
              "id": "<string>",
              "groupId": "<string>",
              "brandGroupId": "<string>"
            },
            "offerId": "<string>",
            "url": "<string>",
            "name": "<string>",
            "description": "<string>",
            "images": [
              {
                "title": "<string>",
                "url": "<string>"
              }
            ],
            "specifications": [
              {
                "displayName": "<string>",
                "values": [
                  "<string>"
                ]
              }
            ],
            "tags": [
              "<string>"
            ],
            "price": {
              "amount": 123,
              "currency": "<string>",
              "currencySymbol": "<string>"
            },
            "seller": "<string>",
            "sellerLogoUrl": "<string>",
            "brandName": "<string>",
            "rating": {
              "value": 123,
              "count": 123
            },
            "canTrackPrice": true
          }
        ]
      }
    ],
    "markdown": "As an AI assistant, I can help you find great laptops for programming..."
  }
}

Overview

The Microsoft Copilot endpoint extracts structured data from Microsoft Copilot with shopping cards for product tracking, ideal 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 proper 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 schema

Includes common response fields plus:

Field	Type	Description
`result.shoppingCards`	array	Array of shopping card objects with product information (automatically included when available)
`result.markdown`	string	Response formatted in Markdown (included when `include.markdown` is true)
`result.rawResponse`	array	Array of Copilot’s streamed response events (included when `include.rawResponse` is true)

Shopping cards

Shopping cards are automatically extracted when Copilot returns product or commercial information. No additional parameters are required - shopping cards are included by default when available in the response.

Shopping card structure

Each shopping card contains:

Field	Type	Description
`type`	string	Shopping card type (e.g., “shoppingProducts”)
`layout`	string	Layout style (e.g., “Carousel”)
`products`	array	Array of detailed product information objects

Product information

Each product includes comprehensive e-commerce data:

Field	Type	Description
`product`	object	Product identifier with `id`, `groupId`, `brandGroupId`
`offerId`	string	Unique offer identifier
`url`	string	Product page URL
`name`	string	Product name
`description`	string	Product description
`images`	array	Product images with `title` and `url`
`specifications`	array	Product specs (e.g., Color, Size) with `displayName` and `values`
`tags`	array	Product tags
`price`	object	Price information with `amount`, `currency`, `currencySymbol`
`seller`	string	Seller name
`sellerLogoUrl`	string	Seller logo URL
`brandName`	string	Product brand name
`rating`	object	Rating with `value` and `count`
`canTrackPrice`	boolean	Whether price tracking is available

Product identifier structure

The product field contains:

Field	Type	Description
`id`	string	Unique product ID
`groupId`	string	Product group ID
`brandGroupId`	string	Brand group ID (optional)

Price structure

The price field contains:

Field	Type	Description
`amount`	number	Price amount
`currency`	string	Currency code (optional)
`currencySymbol`	string	Currency symbol (e.g., ”$“)

Rating structure

The rating field contains:

Field	Type	Description
`value`	number	Rating value
`count`	integer	Number of ratings

Example usage

{
  "prompt": "What are the best laptops for software development?",
  "country": "US"
}

Response with shopping cards:

{
  "success": true,
  "result": {
    "text": "Here are some excellent laptops for software development...",
    "shoppingCards": [
      {
        "type": "shoppingProducts",
        "layout": "Carousel",
        "products": [
          {
            "product": {
              "id": "prod_12345",
              "groupId": "group_12345"
            },
            "offerId": "offer_12345",
            "url": "https://www.microsoft.com/en-us/d/surface-laptop-studio-2/8rqr54krf1dz",
            "name": "Microsoft Surface Laptop Studio 2",
            "description": "The most powerful Surface laptop yet",
            "images": [
              {
                "title": "Front view",
                "url": "https://example.com/surface.jpg"
              }
            ],
            "specifications": [
              {
                "displayName": "Color",
                "values": ["Platinum", "Black"]
              }
            ],
            "tags": ["laptop", "professional"],
            "price": {
              "amount": 1999.99,
              "currency": "USD",
              "currencySymbol": "$"
            },
            "seller": "Microsoft Store",
            "sellerLogoUrl": "https://example.com/microsoft-logo.png",
            "brandName": "Microsoft",
            "rating": {
              "value": 4.7,
              "count": 542
            },
            "canTrackPrice": true
          }
        ]
      }
    ],
    "sources": [
      {
        "position": 1,
        "url": "https://www.microsoft.com/surface",
        "label": "Microsoft Surface",
        "description": "Official Microsoft Surface product information"
      }
    ]
  }
}

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

default:US

Country/region code for localized response

Example:

"US"

include

object

Optional flags for including additional response formats

Show child attributes

Response

successful Copilot monitoring response

success

boolean

required

Example:

true

result

object

required

Copilot response data

Show child attributes

Extract Google AI Overview Extract Grok

​Overview

​Request parameters

​Response schema

​Shopping cards

​Shopping card structure

​Product information

​Product identifier structure

​Price structure

​Rating structure

​Example usage

Authorizations

Body

Response

Overview

Request parameters

Response schema

Shopping cards

Shopping card structure

Product information

Product identifier structure

Price structure

Rating structure

Example usage