| Action: | GET REPORT BY PAGE | |||
| Method: | GET | |||
| URL: | /api/v1/reports/{ReportName} | |||
| Description: | Fetch a page of data from the specified report | |||
| Type | Key | DataType | Notes | |
|---|---|---|---|---|
| Headers | api-key | String | Your Api-Key | |
| Path | ReportName | String | Report Name (e.g. MatchPotential, DataQuality, etc.) | |
| Query | PageIndex | Integer | Index of page to retrieve | |
| Query | PageSize | Integer | Size of the page (number of rows) to retrieve | |
| Query | UserId | Integer | Your User ID | |
| Query | SortColumn | String | Name of the column to sort the data by | |
| Query | SortDirection | String | Which direction should the data be sorted (ASC or DESC) | |
| Query | Filters | String[] | Filters to apply to the data (in format `ColumnName:Base64Value`) | |
| Return Data: | Json collection of paginated report records. | |||
| Action: | GET FILTER METADATA FOR REPORT | |||
| Method: | GET | |||
| URL: | /api/v1/reports/{ReportName}FilterMetadata | |||
| Description: | Fetch filter metadata for the specified report | |||
| Type | Key | DataType | Notes | |
|---|---|---|---|---|
| Headers | api-key | String | Your Api-Key | |
| Path | ReportName | String | Report Name (e.g. MatchPotential, DataQuality, etc.) | |
| Query | UserId | Integer | Your User ID | |
| Return Data: | Json collection of filter metadata for the specified report. | |||