Support

If you encounter issues with the API, please follow these troubleshooting steps:

1. Run the following health check:

   curl 'https://api.example.com/health'
   

   Replace api.example.com with the domain provided during onboarding. This diagnostic endpoint does not require API key authentication. A successful response returns {"message":"API is running"}. If the request fails, possible causes include:
   • The base URL is incorrect
   • A network connectivity issue, such as a firewall restriction or local connection problem
   • The service is currently unavailable

2. If the health check succeeds, verify authentication by running:

   curl -H "X-API-Key: YOUR_API_KEY" \
       "https://api.example.com/v1/perils"
   

   Substitute your API key and base URL. A successful response returns the list of perils available to your account. A 401 Unauthorized response indicates an invalid or expired API key — please confirm the key is correct and active.

3. If both checks above succeed but requests to the peril or batch endpoints still fail, review the request payload formatting.

The peril endpoint returns descriptive validation errors to assist with request formatting, including: illegal trailing commas, duplicate indices, and invalid perils.

When preparing data in Excel, ensure dates follow the YYYY-MM-DD format. You can convert cells using =TEXT(A1,"yyyy-mm-dd"), where A1 is the source cell.

Enquiries

For further assistance, BirdsEyeView customers may contact admin@birdseyeview.ai.