/identity/v1/sessions

Buscar Sesiones

El endpoint /sessions te permite realizar una búsqueda con filtros específicos.

Consideraciones

Tendrás que especificar tus filtros como parámetros siguiendo este patrón: filter[field]=value. Por ejemplo: filter[status]=IN_PROGRESS

Los resultados serán paginados y podrás especificar la cantidad de datos por página y también qué página ver.

Rango de fechas

Hay un filtro para el campo created_at, que podrás usar para obtener las sesiones creadas dentro un rango de fechas. Por ejemplo: filter[created_at][from]=2021-07-27&filter[created_at][to]=2021-07-28

Ordenamiento

Podrás especificar el orden de los resultados con determinados parámetros que deberás enviar como una lista de strings en el filtro de tipo sort. Por ejemplo: ?sort=created_at,updated_at.

El ordenamiento por defecto será ascendente. Para especificar un orden descendente, deberás enviar el carácter '-' como prefijo del atributo. Por ejemplo: ?sort=created_at,-updated_at.

Si un parámetro es incorrecto o está mal escrito, responderemos con un error.

Parámetros disponibles

Header Parameters
AuthorizationString
Query Parameters
filter[user_id]String
filter[status]enum
filter[created_at][from]String
filter[created_at][to]String
page[size]Number
page[number]Number
sortenum

Detalle de respuestas

401
No autorizado
403
Acceso denegado

Ejemplo de código
curl -X GET "https://api.pomelo.la/identity/v1/sessions?filter[user_id]=example_value&filter[status]=CREATED&filter[created_at][from]=1998-08-20&filter[created_at][to]=1998-08-20&page[size]=123&page[number]=123&sort=-created_at" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"
Ejemplo de respuesta (200)OK
{
  "data": [
    {
      "id": "string",
      "user_id": "string",
      "created_at": "string",
      "status": "CREATED",
      "url": "https://example.com",
      "failed_reasons": [
        {
          "reason": "ID_MATCH_FAILED",
          "step": "MATCH_ID",
          "message": "Match Id Not Found"
        }
      ]
    }
  ],
  "meta": {
    "filters": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "pagination": {
      "total_pages": 0,
      "current_page": 0,
      "page_size": 0
    }
  }
}

Pomelo AI

Asistente de inteligencia artificial para consultas sobre la API de Pomelo
¡Hola!¿Cómo puedo ayudarte hoy?
Buscar Sesiones | Pomelo API Reference