1. Introduction

This document contains generated documentation for AMPnet report-service. Report service contains all endpoints for generating reports in PDF Source code is available on Github.

2. Reporting API

All requests need header: Authorization: Bearer JWT.

2.1. Get user transactions report

Query parameters from and to are both optional.

Request
GET /report/user/transactions?from=2019-10-10&to=2021-05-26 HTTP/1.1
Host: localhost:8080

Response is a PDF file data.

2.2. Get user transaction report

Query parameters txHash, fromTxHash and toTxHash are required.

Request
GET /report/user/transaction?txHash=tx_hash&fromTxHash=mint&toTxHash=user+wallet+hash HTTP/1.1
Host: localhost:8080

Response is a PDF file data.

3. Admin Reporting API

All requests need header: Authorization: Bearer JWT.

3.1. Get active users accounts summary report

Query parameters from and to are both optional.

Request
GET /admin/report/user?from=2019-10-10&to=2021-05-27 HTTP/1.1
Host: localhost:8080

Response is a PDF file data.

3.2. User stats report

Admin can download the xlsx report with users list. Following report types are available:

  • REGISTERED - users that have registered on the platform

  • VERIFIED - users that have completed KYC

  • WALLET - users that have initialized wallet

  • DEPOSIT - users that have at least one minted deposit

  • INVESTMENT - users that have completed at least one investment

Query parameter type is mandatory.

Request
GET /admin/report/xlsx?type=VERIFIED HTTP/1.1
Host: localhost:8080

Response is xlsx file data.