Track Copilot answers

Get structured output from Microsoft Copilot on your brand, your products or any other topic, in many regions

post/v1/monitor/copilot

Request

Base URL: https://api.answerline.dev
URL: https://api.answerline.dev/v1/monitor/copilot
Auth: HTTP bearer

Request body

promptstring required

Prompt submitted to Copilot

countrystring required

Code of the country or region used to localize the response

statestring

State code for targeting below the country level (e.g., "CA"; "DC" included). Allowed only when country is "US". Served for Gemini; on a model that cannot place a state yet, a request that includes it is rejected as a validation error and is not charged.

Example request

{
  "prompt": "Which laptop should I buy for software development?",
  "country": "US",
  "include": {
    "html": true,
    "markdown": true,
    "rawResponse": true
  },
  "state": "CA"
}

Response

Copilot monitoring result (success)

successboolean required

Example response

{
  "success": true,
  "result": {
    "text": "Happy to help you pick a monitor that works well for coding...",
    "html": "https://files.answerline.dev/html/c45a5081-808d-4ed3-9c86-e4baf16c8ab8/1/page-1.html",
    "sources": [
      {
        "position": 1,
        "url": "https://docs.microsoft.com/",
        "label": "Microsoft Docs",
        "description": "Official developer docs"
      }
    ],
    "citationPills": [
      {
        "label": "Vendor Help Center",
        "citationPillId": 1,
        "url": "https://docs.microsoft.com/",
        "domain": "docs.microsoft.com",
        "description": "Official developer docs",
        "position": 1
      },
      {
        "label": "Neovim source on GitHub",
        "citationPillId": 1,
        "url": "https://github.com/microsoft/vscode",
        "domain": "github.com",
        "description": "Neovim repository",
        "position": 2
      }
    ],
    "shoppingCards": [
      {
        "type": "shoppingProducts",
        "layout": "Carousel",
        "products": [
          {
            "position": 1
          }
        ]
      }
    ],
    "map": [
      {
        "name": "Lakeside Science Museum",
        "position": 1,
        "placeId": "ChIJEYpTsk__W4gR2sQLGzOjE3o",
        "location": {
          "address": "250 Harbor Dr, Duluth, MN 55802",
          "latitude": 35.823257,
          "longitude": -83.5787498
        },
        "phoneNumber": "(865) 868-1800",
        "url": "http://www.wonderworksonline.com/pigeon-forge/",
        "reviews": [
          {
            "count": 10625,
            "rating": 4.3,
            "providerName": "Google",
            "providerIconUrl": null,
            "url": "https://maps.google.com/?cid=8796553937077126362"
          }
        ],
        "photos": [
          {
            "url": "https://lh3.googleusercontent.com/gps-cs-s/example",
            "altText": null,
            "providerName": null,
            "providerUrl": "https://maps.google.com"
          }
        ],
        "openState": "Open · Closes 8 PM",
        "category": "Amusement park",
        "price": null,
        "layerLabel": "Theme Parks"
      }
    ],
    "searchQueries": [
      "coding laptop recommendations 2025",
      "laptop reviews for programmers"
    ],
    "markdown": "Happy to help you pick a monitor that works well for coding..."
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.