Contentsquarecontentsquare.com
Contentsquare's API program shows strong discoverability and a solid foundational contract, but two areas are holding back partner and agent adoption: every single API operation is undocumented, leaving partners and their AI agents with no context to build against, and error responses are unstructured prose that agents cannot parse or act on reliably. Fixing operation-level documentation and machine-readable error semantics — alongside surfacing auth configuration and idempotency guarantees — will unlock self-serve onboarding and let partners' AI agents integrate with confidence rather than guesswork.
API DesignA clean, typed, well-governed API contract agents can reason about2 pass2 warn1 fail71B
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| warn | Schema coverage & depthvia sdk | 20.8/25 | 4 of 19 public signatures use loose types (anyTypeRatio=0.211). Investigated: sdk 83%. | Typed, complete request/response schemas are what make agent function-calling possible. |
| warn | Machine-readable, versioned contractvia cli | 18.8/25 | `--help --format json` exits 0 but output is not JSON. Investigated: cli 75%. | A current OpenAPI version with a declared versioning scheme lets agents reason about the contract. |
| pass | Security & governance hygienevia sdk | 15/15 | Code is formatter-clean with zero linter errors and zero style warnings. Investigated: sdk 100%, wellknown 100%. | No leaked secrets, no critical lint violations, no OWASP API Top-10 spec smells, and a published vulnerability-disclosure channel. |
| pass | Example coveragevia docs | 10/10 | Docs show code samples in 4 language(s) (top: shell, javascript, swift), and 4 of 20 sampled pages offer ≥ 2 languages side by side. Investigated: docs 100%, sdk 50%, cli 0%. | Examples carry shape semantics schemas under-specify — for humans and agents alike. |
| fail | Auth declared & discoverablevia cli | 0/25 | no auth/config hint in --help. Investigated: cli 0%. | Agents can only authenticate when auth is declared, scoped, and discoverable. |
Developer ExperienceThe context both developers and agents need to integrate fast — onboarding, code samples, complete descriptions and worked examples3 pass0 warn1 fail85A
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| pass | Self-service developer portalvia docs | 29/29 | Signup page found at https://app.contentsquare.com/signup?cs_lite=1&utm_source=csq_website, but no free tier or sandbox is documented in docs/pricing, so an agent may hit a paywall. Investigated: docs 100%. | Self-serve key/account creation is the fast first call for partners, with no sales gate. |
| pass | Quickstart presentvia docs | 25/25 | Quickstart at https://docs.contentsquare.com/en/csq-sdk-android/product-analytics/index includes a runnable first-call code sample. Investigated: docs 100%. | A quickstart is the fastest path from landing page to first successful call. |
| pass | Code samples in docsvia docs | 18/18 | Docs show code samples in 4 language(s) (top: shell, javascript, swift), and 4 of 20 sampled pages offer ≥ 2 languages side by side. Investigated: docs 100%. | Multi-language samples shorten time-to-first-call. |
| fail | Description completenessvia sdk | 0/15 | 11/11 operations lack a description. Investigated: sdk 0%. | Complete descriptions are the context humans and agents need to use endpoints. |
| na | Changelog published | —/13 | No surface produced evidence for this capability in this run. | A published changelog lets partners track changes without surprise. |
Agent DiscoveryPartners and their agents can find your APIs — llms.txt, registries, crawlable and reachable docs2 pass2 warn0 fail89A
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| pass | Registry & SDK presencevia docs | 28/28 | Indexed on Context7 (llmstxt/contentsquare_llms_txt, 5176 snippets). Investigated: docs 100%, sdk 58%, cli 0%, mcp 0%, wellknown 0%. | Listing in MCP registries and publishing SDKs puts the API where agents and their tooling look. |
| warn | llms.txt present, valid & comprehensivevia docs | 24.4/30 | llms.txt covers 283/372 sitemap doc pages (76%); 89 missing. Investigated: docs 81%, sdk 0%. | A valid, comprehensive llms.txt is the machine-readable entry point for agents. |
| warn | Docs reachable, not hard auth-gatedvia docs | 22.5/30 | Server ignores Accept: text/markdown header (0/50 sampled pages return markdown). Investigated: docs 75%. | Agents can only index and fetch docs they can reach — past auth gates and over correct HTTP semantics. |
| pass | Crawlable / AEOvia wellknown | 12/12 | robots.txt lets all monitored AI crawlers reach the docs paths. Investigated: wellknown 100%. | Bots allowed plus a fresh sitemap make docs findable by agent crawlers. |
Agent UnderstandingAgents can correctly interpret your APIs — machine-readable errors, consistent descriptions, structured data, parseable docs2 pass3 warn1 fail69C
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| pass | Operation purpose clarityvia sdk | 25/25 | Surface uses a single dominant casing convention (camelCase). Investigated: sdk 100%. | Agents select the right endpoint from its summary + operationId; clear, named operations make tool-selection reliable — the strongest driver of correct tool choice. |
| warn | Agent-navigable, token-efficient docsvia docs | 19.6/22 | 5 of 50 pages have minor content differences between markdown and HTML. Investigated: docs 89%. | Server-rendered, clean, small-footprint docs are what an agent can cheaply fetch and parse correctly. |
| pass | Docs structured datavia docs | 8/8 | Machine-readable JSON-LD Article markup on 20 of 20 assessed pages (100%), with dateModified present. Investigated: docs 100%. | Structured data (JSON-LD/schema.org) on docs pages gives agents an unambiguous parse target and is what answer engines cite. Detected on the JS-rendered head (Firecrawl) for a bounded page budget, so JS-injected JSON-LD is now caught; pages we can't render are excluded rather than failed. |
| warn | Agent instructions file (AGENTS.md)via sdk | 5/10 | No agents.md or skill.md context file found (nice-to-have for agent operation). Investigated: sdk 50%, cli 0%, wellknown 0%. | An AGENTS.md gives coding agents explicit setup, auth, and usage instructions to interpret and operate the API — beyond llms.txt's link index. |
| warn | Description consistency across surfaces | 3.3/7 | Mean pairwise description similarity across 2 surfaces (docs, sdk) is 17% (threshold 35% for full credit). | Every surface tells the same story about what the product is. |
| fail | Machine-readable errors (RFC 9457)via cli | 0/28 | errors are prose, not a structured envelope. Investigated: cli 0%. | RFC 9457 problem details and a documented error-code inventory let agents parse failures without burning tokens. |
Agent UsabilityAgents have the context to use your APIs reliably, not just find them0 pass2 warn1 fail48F
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| warn | Sandbox separationvia sdk | 10/20 | No test-mode flag or sandbox environment is exposed. Investigated: sdk 50%. | An isolated environment lets agents exercise destructive operations safely. |
| warn | Runnable collection with test scriptsvia sdk | 4.5/9 | README is present but has no runnable quickstart. Investigated: sdk 50%, platform 0%. | A public, maintained collection with assertions is runnable truth agents validate against. |
| fail | Idempotency documentedvia sdk | 0/27 | No built-in retry machinery was found; transient failures are not retried. Investigated: sdk 0%, cli 0%. | Documented idempotency lets agents retry safely. |
| na | Rate-limit signaling | —/22 | No surface produced evidence for this capability in this run. | Machine-readable rate-limit headers let agents throttle adaptively. |
| na | Pagination documented & consistent | —/22 | No surface produced evidence for this capability in this run. | Consistent, documented pagination lets agents traverse collections. |
Resources Discovered
The public resources we found for Contentsquare — the evidence behind the score. All discovered from public sources; nothing here requires access to your systems.
| Agent hints | Context7 (5,176) |
|---|