Reports module
Endpoints for managing Reportings
GET
/reportschedules Returns collection of Report schedule resources
Parameters
No parameters
Example Request
GET /v1.1/voipstudio/reportschedules HTTP/1.1 Host: l7api.com
Responses
200 Success
401 Unauthorized
401 Unauthorized
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": [
{
"id": 145,
"created_at": "2024-05-18 09:33:15",
"culture": 6,
"description": "value",
"emails": "value",
"end_at": "2024-05-18 09:26:07",
"format": 0,
"frequency": "value",
"last_run_at": "2024-05-18 09:32:40",
"name": "value",
"next_run_at": "2024-05-18 09:31:04",
"report_id": 3457,
"start_at": "2024-05-18 09:34:31",
"status": 0,
"timezone": "value"
}
],
"total": 59
}
POST
/reportschedules Creates new Report schedule resource
Parameters
JSON body attributes:
report_id integer
name string
description string
emails array
Array of emails
Array of emails
culture string
start_at date
end_at date
status string
frequency array
Array of frequency config options
Array of frequency config options
timezone string
Example Request
POST /v1.1/voipstudio/reportschedules HTTP/1.1
Host: l7api.com
{
"report_id": 517,
"name": "abcd",
"description": "abcd",
"emails": [
"john@example.com",
"mike@w3c.com"
],
"culture": "abcd",
"start_at": "2024-11-14",
"end_at": "2024-11-14",
"status": "abcd",
"frequency": {
"type": "W",
"time_of_day": [
10
],
"day_of_week": [
1,
5
],
"day_of_month": []
},
"timezone": "abcd"
}
Responses
201 Success
400 Validation error
401 Unauthorized
400 Validation error
401 Unauthorized
Example Response
HTTP/1.1 201 OK
Content-Type: application/json
{
"data": {
"id": 9948,
"created_at": "2019-02-15 22:57:16",
"culture": 6,
"description": "value",
"emails": "value",
"end_at": "2019-02-15 23:10:50",
"format": 0,
"frequency": "value",
"last_run_at": "2019-02-15 23:07:16",
"name": "value",
"next_run_at": "2019-02-15 23:11:06",
"report_id": 1525,
"start_at": "2019-02-15 23:05:22",
"status": 0,
"timezone": "value"
},
"links": {}
}
GET
/reportschedules/{id} Returns Report schedule resource for given Id
Parameters
Endpoint URL:
{id} integerReportSchedule2 identifier
Example Request
GET /v1.1/voipstudio/reportschedules/6 HTTP/1.1 Host: l7api.com
Responses
200 Success
401 Unauthorized
403 Access denied
404 Resource not found
401 Unauthorized
403 Access denied
404 Resource not found
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 1985,
"created_at": "2021-02-06 05:34:46",
"culture": 7,
"description": "value",
"emails": "value",
"end_at": "2021-02-06 05:37:17",
"format": 0,
"frequency": "value",
"last_run_at": "2021-02-06 05:24:18",
"name": "value",
"next_run_at": "2021-02-06 05:25:42",
"report_id": 5514,
"start_at": "2021-02-06 05:33:07",
"status": 1,
"timezone": "value"
},
"links": {}
}
PATCH
/reportschedules/{id} Updates existing Report schedule resource
Parameters
Endpoint URL:
{id} integerReportSchedule2 identifier
JSON body attributes:
report_id integer
name string
description string
emails array
Array of emails
Array of emails
culture string
start_at date
end_at date
status string
frequency array
Array of frequency config options
Array of frequency config options
timezone string
Example Request
PATCH /v1.1/voipstudio/reportschedules/51 HTTP/1.1
Host: l7api.com
{
"report_id": 715,
"name": "abcd",
"description": "abcd",
"emails": [
"john@example.com",
"mike@w3c.com"
],
"culture": "abcd",
"start_at": "2024-11-14",
"end_at": "2024-11-14",
"status": "abcd",
"frequency": {
"type": "W",
"time_of_day": [
10
],
"day_of_week": [
1,
5
],
"day_of_month": []
},
"timezone": "abcd"
}
Responses
200 Success
400 Validation error
401 Unauthorized
403 Access denied
404 Resource not found
400 Validation error
401 Unauthorized
403 Access denied
404 Resource not found
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 7814,
"created_at": "2022-02-10 02:14:46",
"culture": 4,
"description": "value",
"emails": "value",
"end_at": "2022-02-10 02:08:19",
"format": 0,
"frequency": "value",
"last_run_at": "2022-02-10 02:18:50",
"name": "value",
"next_run_at": "2022-02-10 02:08:32",
"report_id": 699,
"start_at": "2022-02-10 02:17:55",
"status": 1,
"timezone": "value"
},
"links": {}
}
DELETE
/reportschedules/{id} Deletes existing Report schedule resource
Parameters
Endpoint URL:
{id} integerReportSchedule2 identifier
Example Request
DELETE /v1.1/voipstudio/reportschedules/27 HTTP/1.1 Host: l7api.com
Responses
204 Success
401 Unauthorized
403 Access denied
404 Resource not found
401 Unauthorized
403 Access denied
404 Resource not found
Example Response
HTTP/1.1 204 OK
GET
/reportschedules/dictionaries Returns Dictionary for Report schedule resource
Parameters
No parameters
Example Request
GET /v1.1/voipstudio/reportschedules/dictionaries HTTP/1.1 Host: l7api.com
Responses
200 Success
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": [
{
"id": 552,
"created_at": "2022-09-17 17:57:31",
"culture": 6,
"description": "value",
"emails": "value",
"end_at": "2022-09-17 17:51:58",
"format": 0,
"frequency": "value",
"last_run_at": "2022-09-17 18:07:23",
"name": "value",
"next_run_at": "2022-09-17 17:52:53",
"report_id": 7961,
"start_at": "2022-09-17 17:51:07",
"status": 0,
"timezone": "value"
}
],
"total": 59
}