Site Search APIs follow common request and response conventions. This article explains the shared patterns and where endpoint families can vary.
Request Conventions
- Each endpoint call lists the HTTP method and full endpoint pattern.
- Each endpoint call lists the required authentication format for that endpoint family.
- Examples focus on one behavior per request.
- Write-operation examples are labeled for safe staging usage where needed.
Response Conventions
- Each endpoint includes a representative success payload.
- Endpoints with non-obvious failures include a representative failure payload.
- Key fields and meanings are called out directly below examples.
Endpoint-Specific Nuance Rules
- Some endpoint families can return app-level failures with
200. Check payload error flags. - Authentication format can differ by endpoint family. Use the endpoint-specific header requirements.
- For shared limits and errors, use Service Limits and Error Handling and HTTP Status Codes.