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": 5949,
"created_at": "2018-08-04 23:58:22",
"culture": 0,
"description": "value",
"emails": "value",
"end_at": "2018-08-05 00:02:30",
"format": 1,
"frequency": "value",
"last_run_at": "2018-08-04 23:51:50",
"name": "value",
"next_run_at": "2018-08-05 00:03:58",
"report_id": 9131,
"start_at": "2018-08-04 23:58:19",
"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": 208,
"name": "abcd",
"description": "abcd",
"emails": [
"john@example.com",
"mike@w3c.com"
],
"format": "abcd",
"culture": "abcd",
"start_at": "2025-01-02",
"end_at": "2025-01-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": 6283,
"created_at": "2023-06-15 01:34:24",
"culture": 1,
"description": "value",
"emails": "value",
"end_at": "2023-06-15 01:34:17",
"format": 1,
"frequency": "value",
"last_run_at": "2023-06-15 01:34:08",
"name": "value",
"next_run_at": "2023-06-15 01:42:23",
"report_id": 2953,
"start_at": "2023-06-15 01:38:54",
"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/99 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": 248,
"created_at": "2020-01-18 01:47:53",
"culture": 3,
"description": "value",
"emails": "value",
"end_at": "2020-01-18 01:45:20",
"format": 0,
"frequency": "value",
"last_run_at": "2020-01-18 01:36:22",
"name": "value",
"next_run_at": "2020-01-18 01:41:24",
"report_id": 8543,
"start_at": "2020-01-18 01:49:57",
"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/57 HTTP/1.1
Host: l7api.com
{
"report_id": 590,
"name": "abcd",
"description": "abcd",
"emails": [
"john@example.com",
"mike@w3c.com"
],
"format": "abcd",
"culture": "abcd",
"start_at": "2025-01-02",
"end_at": "2025-01-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": 7390,
"created_at": "2024-08-06 21:23:54",
"culture": 7,
"description": "value",
"emails": "value",
"end_at": "2024-08-06 21:26:45",
"format": 0,
"frequency": "value",
"last_run_at": "2024-08-06 21:30:23",
"name": "value",
"next_run_at": "2024-08-06 21:34:20",
"report_id": 1612,
"start_at": "2024-08-06 21:18:50",
"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/26 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": 6683,
"created_at": "2021-11-25 08:10:46",
"culture": 2,
"description": "value",
"emails": "value",
"end_at": "2021-11-25 08:13:33",
"format": 0,
"frequency": "value",
"last_run_at": "2021-11-25 08:05:38",
"name": "value",
"next_run_at": "2021-11-25 08:08:58",
"report_id": 910,
"start_at": "2021-11-25 08:14:52",
"status": 0,
"timezone": "value"
}
],
"total": 59
}