This document is generated by Aladia.

Aladia API

Retrieve a Payment Overview

Developing

GET

/analytics/questions/payments/overview

This endpoint provides information about the payments overview for each date in the given period.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.aladia.io/v2/analytics/questions/payments/overview?startDate=2025-01-10T07:48:37.217Z&endDate=2025-01-22T07:48:37.217Z' \
--header 'apikey: '

Response Example

200 - Success

{
  "timeline": [
    {
      "date": "2025-01-23",
      "income": 0,
      "spending": 0
    },
    {
      "date": "2025-01-24",
      "income": 0,
      "spending": 0
    },
    {
      "date": "2025-01-25",
      "income": 0,
      "spending": 0
    },
    {
      "date": "2025-01-26",
      "income": 0,
      "spending": 0
    },
    {
      "date": "2025-01-27",
      "income": 0,
      "spending": 1000
    }
  ],
  "spending": {
    "total": 1000,
    "categories": {
      "courses": 1000,
      "streaming": 0,
      "storage": 0,
      "tokens": 0
    },
    "increase": 100
  },
  "income": {
    "total": 0,
    "categories": {
      "live": {
        "total": 0,
        "courses": []
      },
      "onDemand": {
        "total": 0,
        "courses": []
      }
    },
    "increase": 0
  }
}

Request

Query Params

startDate

string

required

Formatted start date to filter results

Example:

2025-01-10T07:48:37.217Z

endDate

string

required

Formatted end date to filter results

Example:

2025-01-22T07:48:37.217Z

Header Params

apikey

string

optional

Example:

Responses

🟢200Success

application/json

Body

timeline

array [object {3}]

required

The timeline of the provided period

date

string

required

The date corresponding to the recorded income and spending data, formatted as YYYY-MM-DD

income

number

required

The income of that date

spending

number

required

The spending of that date

spending

object

required

total

number

required

The total spending during the period