Reporting API Errors to COSP

To help us investigate and resolve issues effectively, we ask that you provide a clear and structured report when submitting API-related error cases. Consistent reporting allows for faster triage, more accurate analysis, and improved support turnaround.

Please use the following template when reporting an API error to COSP Support.

API Error Report Template

Required information

  • API Operation:

    • The name of the API operation that triggered the error.

    • Example: listTaskProducts

  • API Route:

    • The full route of the endpoint that triggered the error.

    • Example: /tasking/v1/tasks/{taskID}/products

  • API Payload:

    • The parameters used in the request, including:

      • Path parameters (for example, taskID: <uuid>)

      • Query parameters

      • JSON body, if applicable

    Please remove or redact any sensitive data (for example, coordinates, POIs).

  • API Response:

    • The full JSON response or error message returned by the API.

    Please remove or redact any sensitive data (for example, coordinates, POIs).

  • API Version:

    • The version of the API being used.

    • Example: 1.0

  • Timestamp (with Time Zone):

    • The time when the error occurred, including time zone.

    • Format: YYYY-MM-DDTHH:MM:SS±HH:MM (ISO 8601)

Example Error Report
API Operation: listPurchasedItemProducts

API Route: /catalog/v1/purchases/{purchaseID}/products

API Payload:
Path Parameter: purchaseID: 12345

API Response:
{
  "stac_version": "",
  "stac_extensions": null,
  "type": "",
  "features": null,
  "links": null
}

API Version: 1.0

Time Observed: 2025-05-14T06:00:00+02:00
Additional Recommendations

  • Reproducibility: Indicate whether the error occurs consistently or intermittently.

  • Error Frequency: Mention how often the error has been observed (for example, once, every call, intermittently). For questions or clarification, please contact COSP Support. We’re here to help.