Error Codes Returned by the Y.GY Link Shortening API

In this guide, we will talk about what happens when something goes wrong while you work with the API. Mistakes happen, and mostly, they will be yours, not ours. Let's look at some status codes and error types you might encounter.

You can tell if your request was successful by checking the status code when receiving an API response. If a response comes back unsuccessful, you can use the error type and error message to figure out what has gone wrong and do some rudimentary debugging (before contacting support).

Before reaching out to support with an error, please be aware that 99% of all reported errors are, in fact, user errors. Therefore, please carefully check your code before contacting the support with API Questions.

Status codes

Here is a list of the different categories of status codes returned by the API. Use these to understand if a request was successful.

  • Name
    2xx
    Type
    Description

    A 2xx status code indicates a successful response.

  • Name
    4xx
    Type
    Description

    A 4xx status code indicates a client error — this means it's a you problem.

  • Name
    5xx
    Type
    Description

    A 5xx status code indicates a server error — you won't be seeing these.

Error types

Whenever a request is unsuccessful due to a client error, i.e., a 4xx code, the y.gy API will return an error response with an error type and message. You can use this information to understand better what has gone wrong and how to fix it. Most of the error messages are pretty helpful and actionable.

Here is the structure of Error Object returned by y.gy API.

  • Name
    error_code
    Type
    Description

    Short name describing the error.

  • Name
    status_code
    Type
    Description

    HTTP status code, mostly 400.

  • Name
    field_key
    Type
    Description

    [Optional] Name of the field the error is associated with.

  • Name
    error_string
    Type
    Description

    [Optional] Detailed description of the error.

Error response

{
    "status_code": 400,
    "error_code": "KEY_MISSING",
    "field_key": "destination_url",
    "error_string": "Please enter a value for this field."
}