Reports

Profit reports

Profit reports for the authenticated team.

get/reports/profit

Request

  • Base URL
    https://api.midday.ai
  • URL
    https://api.midday.ai/reports/profit
  • Auth
    • OAuth 2
      Authorization code: https://app.midday.ai/oauth/authorize
      Token URL: https://api.midday.ai/oauth/token
    • or HTTP bearer

Query parameters

fromstring required

Start date (ISO 8601 format)

Example:2023-01-01
tostring required

End date (ISO 8601 format)

Example:2023-12-31
currencystring

Currency code (ISO 4217)

Example:USD
revenueType'gross' | 'net'

Type of revenue calculation

Example:net

Response

Profit reports for the authenticated team.

Example response

{
  "summary": {
    "currentTotal": 10000,
    "prevTotal": 8000,
    "currency": "USD"
  },
  "meta": {
    "type": "profit",
    "currency": "USD"
  },
  "result": [
    {
      "date": "2023-01-31",
      "percentage": {
        "value": 25,
        "status": "positive"
      },
      "current": {
        "date": "2023-01-31",
        "value": 1000,
        "currency": "USD"
      },
      "previous": {
        "date": "2022-01-31",
        "value": 800,
        "currency": "USD"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.