Skip to main content
GET /api/v1/discovery
Returns the most recent completed discovery scan for your organization along with the platforms detected during that scan. If no scan has been completed, scan is null and platforms is an empty array. Required scope: discovery:read

Request

curl "https://assess.ayliea.com/api/v1/discovery?limit=50" \
  -H "X-API-Key: ayliea_pk_YOUR_API_KEY"

Query parameters

limit
integer
default:"100"
Maximum number of platforms to return. Must be between 1 and 100.
offset
integer
default:"0"
Number of platforms to skip. Must be 0 or greater.
Pagination applies to the platforms array only. The scan object is always returned in full.

Response

{
  "scan": {
    "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
    "organization_id": "550e8400-e29b-41d4-a716-446655440000",
    "status": "completed",
    "domain": "example.com",
    "started_at": "2026-03-15T14:00:00Z",
    "completed_at": "2026-03-15T14:30:00Z",
    "summary": {
      "platforms_discovered": 14,
      "shadow_ai_count": 3,
      "overall_risk_score": 65
    }
  },
  "platforms": [
    {
      "id": "c56a4180-65aa-42ec-a945-5fd21dec0538",
      "platform_name": "ChatGPT",
      "platform_type": "llm_chat",
      "url": "https://chat.openai.com",
      "confidence": 0.95,
      "metadata": {
        "vendor": "OpenAI",
        "category": "LLM Chat"
      },
      "created_at": "2026-03-15T14:15:00Z"
    },
    {
      "id": "e7b1f3a0-4c2d-4b8e-9f1a-2d3c4e5f6a7b",
      "platform_name": "GitHub Copilot",
      "platform_type": "code_assistant",
      "url": "https://github.com/features/copilot",
      "confidence": 0.88,
      "metadata": {
        "vendor": "GitHub",
        "category": "Code Assistant"
      },
      "created_at": "2026-03-15T14:18:00Z"
    }
  ]
}

Response fields

scan
object | null
required
The most recent completed discovery scan, or null if no scan has been completed.
platforms
array
required
Platforms detected during the scan, sorted by confidence score (highest first).

No scan completed

If your organization has not completed a discovery scan, the response is:
{
  "scan": null,
  "platforms": []
}

Notes

  • Only the most recent completed scan is returned. Historical scans are not available through the API.
  • The metadata object structure varies by platform and may include additional fields beyond vendor and category in future versions.
  • Platforms are sorted by confidence descending. Use pagination to retrieve large result sets.