Get dashboard

Request

Request header:

GET https://api.ipaymy.com/v2/payments_history/dashboard
Host: api.ipaymy.com
Accept: application/json
Authorization: Bearer your_access_token

Params:

duration: last_month | last_2_month | last_3_month | all

pay_statistics: y | n

fetch_statistics: y | n

payee_statistics: y | n

pay_insights: y | n

outgoing_payment_summary: y | n

outgoing_payment_summary_in_this_month: y | n

incoming_payment_summary: y | n

incoming_payment_summary_in_this_month: y | n

Response

Response body:

{
  "pay_insights": {
    "total_payment_amount": 434286,
    "average_payment_amount": 24127,
    "percentage_of_recurring_payments": 40.909090909090914,
    "percentage_of_one_time_payments": 59.090909090909086
  },
  "pay_statistics": {
    "number_of_active_recipients": 6,
    "number_of_in_progress_payments": 151,
    "number_of_payments_made": 18,
    "number_of_recurring_payments": 4,
    "total_payments_made": 434286
  },
  "payee_statistics": [
    {
      "total": 2,
      "purpose_id": 1
    },
    {
      "total": 5,
      "purpose_id": 2
    },
    {
      "total": 8,
      "purpose_id": 3
    }
  ]
}

Response codes:

• 200: Good stuff, and the response body should be easy to parse.
• 422: Typically malformed JSON, such as an integer in place of the required alphanumeric string, or a missing key. Check the response body for further details.