Statistics API

get_received_payments

Obtener una lista de tus pagos recibidos.

Ejemplo

curl https://bitbooklite.com/api/v2/?apiUser=00000-AAAAA-00000-AAAAA-00000&apiPassword=000000-AAAAAA-000000-AAAAAA-000000
        -d 'api_consult_type=get_received_payments'
        -d 'operation_data={"limit":10}'

Endpoint

https://bitbooklite.com/api/v2/

GET parameters

apiUser (obligatorio - string): Usuario de tu credencial de acceso API.
apiPassword (obligatorio - string): Contraseña de tu credencial de acceso API.

POST parameters

api_consult_type (obligatorio - string): Método de la API, en este caso, "get_received_payments".
operation_data (obligatorio - json encoded array):
- limit (obligatorio - integer): Limite de elementos a obtener (máximo 500).
- limitStart (opcional - integer): Inicio del límite, útil para paginación de resultados. DEFAULT = 0
- orderBy (opcional - string): Columna por la que ordenar los resultados. Valores admitidos: ["id", "cantidad", "fecha"]. DEFAULT = "id"
- orderMode (opcional - string): Modo de ordenar los resultados. Valores admitidos: ["ASC", "DESC"]. DEFAULT = "DESC"
- processor (opcional - string): Si se envía, solo se retornarán resultados con este procesador de pagos.

Valores devueltos

JSON


            {
                "error":false,
                "errores":[],
                "answer":{
                    "payments":[
                        {
                            "id":170,
                            "amount":105.26,
                            "amount_formated":"105,26",
                            "currency":"USD",
                            "book_id":1523,
                            "date":"2023-05-15 21:20:31",
                            "date_formated":"16/05/2023 00:20:31 GMT+0",
                            "processor":"paypal_unique",
                            "processor_fee":5.263,
                            "platform_fee":10.526,
                        }
                    ]
                }
            }

error (obligatorio - boolean): "true" en caso de error.
errores (obligatorio - array): Conjunto de strings con los errores producidos, si existen.
answer (obligatorio - array): respuesta del servidor.
- payments (obligatorio - array): lista de pagos recibidos.
  - id (obligatorio - integer): ID del pago.
  - amount (obligatorio - float): monto del pago.
  - currency (obligatorio - string): moneda del pago.
  - book_id (obligatorio - integer): ID del libro vendido.
  - processor (obligatorio - string): Nombre del procesador de pagos.
  - processor_fee (opcional - float): Monto de la comisión del procesador de pagos.
  - platform_fee (opcional - float): Monto de la comisión de BitBook Lite.
  - ...

get_received_payments_stats

Obtener estadísticas de tus pagos recibidos.

Ejemplo

curl https://bitbooklite.com/api/v2/?apiUser=00000-AAAAA-00000-AAAAA-00000&apiPassword=000000-AAAAAA-000000-AAAAAA-000000
        -d 'api_consult_type=get_received_payments_stats'
        -d 'operation_data={"interval":"day","regression":30}'

Endpoint

https://bitbooklite.com/api/v2/

GET parameters

apiUser (obligatorio - string): Usuario de tu credencial de acceso API.
apiPassword (obligatorio - string): Contraseña de tu credencial de acceso API.

POST parameters

api_consult_type (obligatorio - string): Método de la API, en este caso, "get_received_payments_stats".
operation_data (obligatorio - json encoded array):
- interval (obligatorio - string): Intervalo de tiempo. Debe ser uno de estos valores: ["day", "month"].
- regression (obligatorio - integer): Número de pasos regresivos del intervalo de tiempo. Ejemplo: si interval es "day" y regression es 10, se retornarán las estadísticas de los últimos 10 días.

Valores devueltos

JSON


            {
                "error":false,
                "errores":[],
                "answer":{
                    "results":[
                        {
                            "total":2,
                            "init_date":"2023-05-23 00:00:00",
                            "end_date":"2023-05-22 00:00:00",
                            "payments":[
                                {
                                    "id":170,
                                    "amount":105.26,
                                    "amount_formated":"105,26",
                                    "currency":"USD",
                                    "book_id":1523,
                                    "date":"2023-05-15 21:20:31",
                                    "date_formated":"16/05/2023 00:20:31 GMT+0",
                                    "processor":"paypal_unique",
                                    "processor_fee":5.263,
                                    "platform_fee":10.526,
                                },
                                {
                                    "id":171,
                                    "amount":105.26,
                                    "amount_formated":"105,26",
                                    "currency":"USD",
                                    "book_id":1556,
                                    "date":"2023-05-15 21:20:31",
                                    "date_formated":"16/05/2023 00:20:31 GMT+0",
                                    "processor":"paypal_unique",
                                    "processor_fee":5.263,
                                    "platform_fee":10.526,
                                },
                            ],
                        }
                    ]
                }
            }

error (obligatorio - boolean): "true" en caso de error.
errores (obligatorio - array): Conjunto de strings con los errores producidos, si existen.
answer (obligatorio - array): respuesta del servidor.
- results (obligatorio - array): lista de datos de cada intervalo.
  - total (obligatorio - integer): Número de pagos recibidos en este período.
  - init_date (obligatorio - string): Fecha de inicio de este período.
  - end_date (obligatorio - string): Fecha de final de este período.
  - payments (obligatorio - array): Lista de pagos recibidos en este período.

get_anlyt_stats

Obtener estadísticas con el sistema CrafyAnlyt. El sistema CrafyAnlyt administra múltiples estadísticas numéricas a través del tiempo, como el número de libros que has leido, el número de libros que has vendido, etc.

Ejemplo

curl https://bitbooklite.com/api/v2/?apiUser=00000-AAAAA-00000-AAAAA-00000&apiPassword=000000-AAAAAA-000000-AAAAAA-000000
        -d 'api_consult_type=get_anlyt_stats'
        -d 'operation_data={"input_mode":"to_today","order_mode":"ASC","ref_id":"123","sector":"book_reads","regression":30}'

Endpoint

https://bitbooklite.com/api/v2/

GET parameters

apiUser (obligatorio - string): Usuario de tu credencial de acceso API.
apiPassword (obligatorio - string): Contraseña de tu credencial de acceso API.

POST parameters

api_consult_type (obligatorio - string): Método de la API, en este caso, "get_anlyt_stats".
operation_data (obligatorio - json encoded array):
- input_mode (obligatorio - string): Modo de entrada. Debe ser uno de estos valores: ["by_date" (obtiene datos entre dos fechas específicas), "to_today" (obtiene datos entre hoy y un determinado número de días hacia el pasado)].
- order_mode (obligatorio - string): Modo de ordenar los resultados por su fecha. Debe ser uno de estos valores: ["ASC" (ascendente), "DESC" (descendente)].
- ref_id (obligatorio - string): ID de referencia. Es el identificador base de los datos que obtendrás como resultado y depende del valor del parámetro sector. Por ejemplo, si obtienes una estadística de tu cuenta (como el número de libros que has leido), el ID de referencia será el ID de tu cuenta. En algunos casos puede usarse 0 para obtener las estadísticas globales de la plataforma.
- sector (obligatorio - string): Sector del cual obtener estadísticas. Estos son los sectores disponibles:
  - user_reads: Número de lecturas de un usuario.
  - book_reads: Número de lecturas de un libro.
  - book_sells: Número de copias vendidas de un libro.
  - book_sells_in_free: Número de copias vendidas de un libro gratuitamente.
  - book_sells_in_ltb: Número de copias vendidas de un libro por Litbits.
  - book_sells_in_bblusd: Número de copias vendidas de un libro por dinero.
  - writer_reads: Número de lecturas totales de los libros de un usuario.
  - reader_ads_earnings: Total ganado por un usuario gracias a leer libros gratuitos.
  - writer_ads_earnings: Total ganado por un usuario gracias a que se hayan leido sus libros publicados.
  - ref_readers_ads_earnings: Total ganado por un usuario gracias a las lecturas de sus referidos de cuenta.
  - ref_writers_ads_earnings: Total ganado por un usuario gracias a las lecturas de libros publicados por sus referidos de cuenta.
  - tmp_ref_readers_ads_earnings: Total ganado por un usuario gracias a las lecturas de sus referidos temporales.
  - tmp_ref_writers_ads_earnings: Total ganado por un usuario gracias a las lecturas de libros publicados por sus referidos temporales.
  - scd_ref_readers_ads_earnings: Total ganado por un usuario gracias a las lecturas de sus referidos de segundo nivel.
  - scd_ref_writers_ads_earnings: Total ganado por un usuario gracias a las lecturas de libros publicados por sus referidos de segundo nivel.
  - writer_selled_books: Número de libros vendidos por un usuario.
  - writer_selled_books_in_free: Número de libros vendidos por un usuario gratuitamente.
  - writer_selled_books_in_ltb: Número de libros vendidos por un usuario por Litbits.
  - writer_selled_books_in_bblusd: Número de libros vendidos por un usuario por dinero.
  - Nota: el ID que debes establecer en ref_id depende del sector elegido. Por ejemplo: "user_reads" obtiene estadísticas de un usuario, por lo que ref_id debe ser el ID de un usuario; "book_reads" obtiene estadísticas de un libro, por lo que ref_id debe ser el ID de un libro.
- init_date (opcional - string): Fecha de inicio (inclusiva) en formato ISO 8601 (año-mes-día). Necesario cuando input_mode es "by_date".
- end_date (opcional - string): Fecha final (inclusiva) en formato ISO 8601 (año-mes-día). Necesario cuando input_mode es "by_date".
- regression (opcional - integer): Número de días a retroceder desde la fecha actual. Necesario cuando input_mode es "to_today". Empieza desde el 0. Un regression de "0" obtendrá únicamente los datos del día actual, mientras que "1" obtendrá los datos desde ayer hasta hoy, etc.

Valores devueltos

JSON


            {
                "error":false,
                "errores":[],
                "answer":{
                    "result":[
                        {
                            "ref_date":"2023-10-19",
                            "counter":"3",
                            "amount":"0"
                        },
                        {
                            "ref_date":"2023-10-20",
                            "counter":"10",
                            "amount":"7"
                        },
                        {
                            "ref_date":"2023-10-21",
                            "counter":"30",
                            "amount":"20"
                        }
                    ]
                }
            }

error (obligatorio - boolean): "true" en caso de error.
errores (obligatorio - array): Conjunto de strings con los errores producidos, si existen.
answer (obligatorio - array): respuesta del servidor.
- result (obligatorio - array): lista de datos de cada día.
  - ref_date (obligatorio - string): Fecha en formato ISO 8601 (año-mes-día).
  - counter (obligatorio - string): Total acumulado hasta ese día.
  - amount (obligatorio - string): Variación del día con respecto al día anterior.

Nuevo post

Categorías del post

Qué es Statistics API

Puntos clave

Métodos y ejemplos

get_received_payments

Ejemplo

Endpoint

GET parameters

POST parameters

Valores devueltos

get_received_payments_stats

Ejemplo

Endpoint

GET parameters

POST parameters

Valores devueltos

get_anlyt_stats

Ejemplo

Endpoint

GET parameters

POST parameters

Valores devueltos