Search the AxiTrace documentation, the public API reference and the developer guide through REST API v1 and the MCP tool search_docs, and get the matching sections with their links.

Docs search through REST API and MCP

Search this documentation by keywords: the setup guides of every store platform and integration, the JavaScript SDK and event reference, cookie consent, attribution, fraud detection, troubleshooting, the operations of the public API and a developer guide. The answer is the best matching sections, each with its page, heading, link and text, so an AI assistant can answer a how-to question and point to the right page. It is the same search the Axi assistant uses.

Access

The search reads no workspace data, so it needs no scope and no workspace: any valid connection or personal access token may call it. Authentication, envelopes, errors and rate limits follow the REST API v1 reference; full schemas are in the OpenAPI document.

Operation

RESTMCP toolWhat it does
GET /api/v1/docs/search?q=...search_docsFull-text search (BM25) over the docs sections, ordered by relevance, with at most two sections of one page.
  • q (MCP: query): what to look up, in a few words or a question, in English, at most 300 characters.
  • limit: how many results to return, 1 to 10. Default 5.

Example

curl -H "Authorization: Bearer $TOKEN" \
  "https://axitrace.com/api/v1/docs/search?q=cookie+consent+shopify&limit=2"
{
  "data": {
    "query": "cookie consent shopify",
    "results": [
      {
        "title": "Cookie consent",
        "section": "What each surface does",
        "url": "https://axitrace.com/docs/cookie-consent#surfaces",
        "kind": "doc",
        "score": 12.84,
        "text": "With Respect cookie consent on, this is what each surface does in the browser..."
      },
      {
        "title": "Shopify integration",
        "section": "Customer privacy",
        "url": "https://axitrace.com/docs/integrations/shopify#privacy",
        "kind": "doc",
        "score": 9.31,
        "text": "The pixel reads Shopify's customer privacy API..."
      }
    ]
  }
}
  • kind is doc for a docs page, api for an operation of the public API, and developer for the developer guide.
  • section is the heading inside the page, or the API endpoint; url links to the page with the section anchor.
  • score is the relevance: higher is more relevant. Scores are comparable only within one answer.

Errors

  • 400 invalid_request: q is missing, empty or longer than 300 characters, or limit is outside 1 to 10.
  • 401: the request carries no valid token.