Skip to main content

Errors in Rize's GraphQL API

The Rize GraphQL API uses standardized error codes and messages to help you identify and resolve issues. Below is a detailed guide to common errors and their solutions.

Error Structure​

All errors returned by the API follow this structure:

{
  "errors": [
    {
      "message": "Error message details",
      "locations": [
        {
          "line": 3,
          "column": 5
        }
      ],
      "path": ["queryName"],
      "extensions": {
        "code": "BAD_USER_INPUT",
      }
    }
  ]
}

Key Fields:

  • message: Human-readable error message.
  • locations: The part of the query where the error occurred.
  • path: The field path causing the error.
  • extensions.code: A specific error code for categorization.

Error Handling Tips​

  1. Read the Error Message: Focus on the message field for immediate clues about the problem.
  2. Check the Path: The path field points to the exact field in your query causing the issue.
  3. Use Correct Extensions: Refer to the extensions.code for detailed categorization of the error.
  4. Retry: For server or network-related errors, implement retry logic with exponential backoff.
  5. Log Errors: Log the complete error response for debugging and reporting to Rize API support.

Contacting Support​

If an error persists and the solution is not clear:

  • Email: support@rize.io
  • Include: Full error response, query, and any relevant variables.