Respuesta

Al llamar a esta ruta en la API, obtendrás una respuesta específica dependiendo del estado de la solicitud.

La estructura de la respuesta siempre es la misma con la siguiente estructura:

{
    "success": bool,
    "data": Data Object,
    "error": Error Object,
    "pagination": Pagination Object
}

Response Objects

success

• true: La solicitud fue exitosa. El objeto error será un dict vacío {}.
• false: La solicitud no tuvo éxito. Se puede encontrar más información sobre el error en el objeto error.

data

Este objeto contendrá los datos en caso de una solicitud exitosa. Siempre contendrá user_id o account_id y todos los demás campos serán dinámicos, de acuerdo a la ruta que llamaste.

Campos dinámicos:

• country: El país de la cuenta del usuario.
• platform: La plataforma de la cuenta del usuario.
• message: Información proporcionada en caso de una conexión fallida.
• profile: Datos de perfil del usuario. Consulta la sección Profile para más información.
• earnings: (Gig economy) Ganancias del usuario. Consulta la sección Earnings para más información.
• employment: (Empleos formales) Historial laboral del usuario. Consulta la sección Employment para más información.

error

Este objeto contendrá información sobre el error en caso de una solicitud fallida.

"error":{
    "code": str,
    "message": str,
    "errors": [
        {
            "message": str,
            "location": str
        }
    ]
}

Para obtener más información sobre posibles errores, consulta la sección Errores.

pagination

Este objeto solo se incluirá en la respuesta para las rutas donde se utiliza paginación, como:

• POST /accounts/:account_id/earnings/search
• POST /accounts

"pagination": {
    "page": 1,
    "items_per_page": 50,
    "total_items": 200,
    "total_pages": 4
}

El valor predeterminado para items_per_page es 100, a menos que se especifique un valor distinto en el payload de la solicitud.