Reports module
Endpoints
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": 8480,
"created_at": "2020-04-11 19:39:02",
"culture": 0,
"description": "value",
"emails": "value",
"end_at": "2020-04-11 19:37:13",
"format": 1,
"frequency": "value",
"last_run_at": "2020-04-11 19:42:43",
"name": "value",
"next_run_at": "2020-04-11 19:41:46",
"report_id": 7167,
"start_at": "2020-04-11 19:49:27",
"status": 1,
"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
format string
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": 958,
"name": "abcd",
"description": "abcd",
"emails": [
"john@example.com",
"mike@w3c.com"
],
"format": "abcd",
"culture": "abcd",
"start_at": "2025-05-02",
"end_at": "2025-05-02",
"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": 8191,
"created_at": "2022-03-03 16:41:33",
"culture": 1,
"description": "value",
"emails": "value",
"end_at": "2022-03-03 16:28:40",
"format": 0,
"frequency": "value",
"last_run_at": "2022-03-03 16:26:27",
"name": "value",
"next_run_at": "2022-03-03 16:28:02",
"report_id": 2742,
"start_at": "2022-03-03 16:45:19",
"status": 1,
"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/39 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": 292,
"created_at": "2021-01-26 02:56:16",
"culture": 0,
"description": "value",
"emails": "value",
"end_at": "2021-01-26 02:53:27",
"format": 1,
"frequency": "value",
"last_run_at": "2021-01-26 02:54:22",
"name": "value",
"next_run_at": "2021-01-26 02:57:03",
"report_id": 6880,
"start_at": "2021-01-26 02:52:03",
"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
format string
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/49 HTTP/1.1
Host: l7api.com
{
"report_id": 849,
"name": "abcd",
"description": "abcd",
"emails": [
"john@example.com",
"mike@w3c.com"
],
"format": "abcd",
"culture": "abcd",
"start_at": "2025-05-02",
"end_at": "2025-05-02",
"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": 8678,
"created_at": "2020-05-12 11:48:05",
"culture": 1,
"description": "value",
"emails": "value",
"end_at": "2020-05-12 11:46:52",
"format": 0,
"frequency": "value",
"last_run_at": "2020-05-12 11:38:14",
"name": "value",
"next_run_at": "2020-05-12 11:57:08",
"report_id": 8455,
"start_at": "2020-05-12 11:42:52",
"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/40 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": 8643,
"created_at": "2017-09-21 03:04:51",
"culture": 2,
"description": "value",
"emails": "value",
"end_at": "2017-09-21 02:50:55",
"format": 1,
"frequency": "value",
"last_run_at": "2017-09-21 03:04:03",
"name": "value",
"next_run_at": "2017-09-21 03:00:42",
"report_id": 419,
"start_at": "2017-09-21 03:08:21",
"status": 1,
"timezone": "value"
}
],
"total": 59
}