Schedule by ID
GET https://api.letpay.io/myreports/schedule/:scheduleId
Retrieve the List of Reports with Scheduled Execution
This endpoint is used to retrieve a specific schedule by its unique identifier.
Authorization
| AUTHORIZATION | API Key |
|---|---|
| Key | X-Auth-Token |
| Value | MY_ACCESS_TOKEN |
Example Request
- 200 - OK
- 401 - Unauthorized
- 404 - Not Found
Example Request
200 - OK
curl --location -g 'https://api.letpay.io/myreports/report/{{reportId}}' \
--header 'X-Auth-Token: MY_ACCESS_TOKEN' \
Example Response
Header
Content-Type: application/json
Body
{
"id": 198,
"name": "Payment of last 7 days",
"folder": "financeiro",
"report_type": "PAYIN",
"enable": true,
"offset": null,
"limit": null,
"fields": [
{
"field": {
"id": 1
},
"id": 124,
"position": 1,
"alias": "Amount",
"aggregation_operator": null,
"arithmetic_operator": null,
"wrap": null,
"open_parentheses": false,
"close_parentheses": false
},
{
"field": {
"id": 56
},
"id": 125,
"position": 2,
"alias": "Channel",
"aggregation_operator": null,
"arithmetic_operator": null,
"wrap": null,
"open_parentheses": false,
"close_parentheses": false
}
],
"filters": [
{
"field": {
"id": 3
},
"id": 82,
"position": 1,
"filter_operator": ">=",
"value": "LAST_7_DAYS",
"logical_operator": "AND",
"dynamic_filter": true
},
{
"field": {
"id": 3
},
"id": 81,
"position": 2,
"filter_operator": "<",
"value": "CURRENT_DAY",
"logical_operator": "AND",
"dynamic_filter": true
}
],
"group_by": [
""
],
"order_by": [
{
"id": 59,
"position": 1,
"field_position": 1,
"direction": "ASC"
}
],
"report_type_name": "Payin"
}