{ "uuid": "5e964f2f-b947-4aff-9ab6-97a88ae28223", "lastMigration": 29, "name": "Reports API", "endpointPrefix": "", "latency": 0, "port": 3000, "hostname": "", "routes": [ { "uuid": "b28d4d5b-5e71-4244-bd12-3f0f9f625495", "documentation": "List reports", "method": "get", "endpoint": "v2/reports", "responses": [ { "uuid": "670202e7-02d4-46d3-bc1c-3e5551a79d51", "body": "{\n \"items_count\": {{faker 'number.int' max=99999}},\n \"reports\": [\n \"\"\n ],\n \"self_link\": \"https://api.nexmo.com/v2/reports/\"\n}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "91479392-2222-4861-b665-e075daa27bbe", "body": "{\n \"detail\": \"Invalid request parameter.\",\n \"instance\": \"f94b4e56604e07e5e5ad5a7228618f81\",\n \"title\": \"Invalid request parameter\",\n \"type\": \"https://developer.nexmo.com/api-errors/reports#invalid-request-parameters\"\n}", "latency": 0, "statusCode": 400, "label": "Bad Request", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "014b107c-2535-4eb7-858d-1a5e15481220", "body": "{\n \"detail\": \"You did not provide correct credentials.\",\n \"instance\": \"f94b4e56604e07e5e5ad5a7228618f81\",\n \"title\": \"Unauthorized\",\n \"type\": \"https://developer.nexmo.com/api-errors#unauthorized\"\n}", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "4980c238-4ca4-44b1-a8f6-87e07bd8b47f", "documentation": "Create an asynchronous report", "method": "post", "endpoint": "v2/reports", "responses": [ { "uuid": "6d597b2e-7176-4525-8479-5d7d064039a3", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "OK", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "97069b5d-f6bd-4ef2-a2f4-592ca7debc50", "body": "{\n \"detail\": \"Malformed JSON payload.\",\n \"instance\": \"f94b4e56604e07e5e5ad5a7228618f81\",\n \"title\": \"Malformed JSON\",\n \"type\": \"https://developer.nexmo.com/api-errors#invalid-json\"\n}", "latency": 0, "statusCode": 400, "label": "Bad Request", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "00b67185-61a6-44ba-9606-86e68f19929c", "body": "{\n \"detail\": \"You did not provide correct credentials.\",\n \"instance\": \"f94b4e56604e07e5e5ad5a7228618f81\",\n \"title\": \"Unauthorized\",\n \"type\": \"https://developer.nexmo.com/api-errors#unauthorized\"\n}", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "f60fc60f-55e0-4bfe-a841-571720d2ff45", "body": "{\n \"detail\": \"User not authorized to query the requested data.\",\n \"instance\": \"f94b4e56604e07e5e5ad5a7228618f81\",\n \"title\": \"Forbidden\",\n \"type\": \"https://developer.nexmo.com/api-errors#forbidden\"\n}", "latency": 0, "statusCode": 403, "label": "Forbidden", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "25ddfbf3-e3cf-4cdb-988c-038a2b5e6266", "body": "{\n \"detail\": \"Unprocessable entity.\",\n \"instance\": \"f94b4e56604e07e5e5ad5a7228618f81\",\n \"title\": \"Unprocessable entity\",\n \"type\": \"https://developer.nexmo.com/api-errors#not-found\"\n}", "latency": 0, "statusCode": 422, "label": "Unprocessable entity", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "6e9e80f2-4d6c-4a22-9800-dab20c3f2586", "documentation": "Load records synchronously", "method": "get", "endpoint": "v2/reports/records", "responses": [ { "uuid": "15134cc1-40a4-4774-953d-f817278af86e", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "OK", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "5731a29d-a85c-429e-887c-fbef8c6bf777", "body": "{\n \"detail\": \"User not authorized to query the requested data\",\n \"instance\": \"f94b4e56604e07e5e5ad5a7228618f81\",\n \"title\": \"Forbidden\"\n}", "latency": 0, "statusCode": 403, "label": "Unprocessable entity", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "a87273c1-66f3-4826-84c0-a1868fdcb7bf", "body": "{\n \"instance\": \"f94b4e56604e07e5e5ad5a7228618f81\",\n \"invalid_parameters\": [\n {\n \"name\": \"date_end\",\n \"reason\": \"Missing required parameter\"\n }\n ],\n \"title\": \"Unprocessable entity\"\n}", "latency": 0, "statusCode": 422, "label": "Unprocessable entity", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c0572c62-ba58-4907-9d84-0cd171d9b1b7", "documentation": "Cancel the execution of a report", "method": "delete", "endpoint": "v2/reports/:report_id", "responses": [ { "uuid": "d5d5fa1f-dcc7-477d-bf27-13e0984d747a", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "OK", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "7ed12717-c9e3-42fc-b05c-54bb7d84fa36", "body": "{\n \"detail\": \"You did not provide correct credentials.\",\n \"instance\": \"f94b4e56604e07e5e5ad5a7228618f81\",\n \"title\": \"Unauthorized\",\n \"type\": \"https://developer.nexmo.com/api-errors#unauthorized\"\n}", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "c40ba1ec-befe-4537-aae5-0104a7757156", "body": "{\n \"detail\": \"Report aaaaaaaa-bbbb-cccc-dddd-0123456789ab does not exist, or you do not have access.\",\n \"instance\": \"f94b4e56604e07e5e5ad5a7228618f81\",\n \"title\": \"Invalid report ID\",\n \"type\": \"https://developer.nexmo.com/api-errors#not-found\"\n}", "latency": 0, "statusCode": 404, "label": "Not found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "c1010104-4e28-4bd7-b554-3e3bf21d259d", "body": "{\n \"detail\": \"The job is already in a terminated state such as `SUCCESS`, `TRUNCATED`, `FAILED` or `ABORTED`.\",\n \"instance\": \"f94b4e56604e07e5e5ad5a7228618f81\",\n \"title\": \"Invalid Abort Operation\",\n \"type\": \"https://developer.nexmo.com/api-errors/reports#invalid-abort-operation\"\n}", "latency": 0, "statusCode": 409, "label": "Invalid Abort Operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c30f31b0-faff-4006-a1af-9bc8132a2d25", "documentation": "Get status of report", "method": "get", "endpoint": "v2/reports/:report_id", "responses": [ { "uuid": "5a08b478-83d6-4acc-b10c-9de3d7091ab1", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "OK", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "9d4abc4a-136f-40c9-b8a0-0cca0deff8a7", "body": "{\n \"detail\": \"You did not provide correct credentials.\",\n \"instance\": \"f94b4e56604e07e5e5ad5a7228618f81\",\n \"title\": \"Unauthorized\",\n \"type\": \"https://developer.nexmo.com/api-errors#unauthorized\"\n}", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "6eecd7e7-ee68-41f2-965d-62ac663502dd", "body": "{\n \"detail\": \"Report aaaaaaaa-bbbb-cccc-dddd-0123456789ab does not exist, or you do not have access.\",\n \"instance\": \"f94b4e56604e07e5e5ad5a7228618f81\",\n \"title\": \"Invalid report ID\",\n \"type\": \"https://developer.nexmo.com/api-errors#not-found\"\n}", "latency": 0, "statusCode": 404, "label": "Not found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "5c055367-87bf-451e-9c10-112d00adfd66", "documentation": "Get report data", "method": "get", "endpoint": "v3/media/:file_id", "responses": [ { "uuid": "18423687-ab70-4a98-9e2f-f36be99ec511", "body": "", "latency": 0, "statusCode": 200, "label": "Zip file containing CSV files", "headers": [ { "key": "Content-Type", "value": "application/octet-stream" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "0493a54a-4e4a-4423-a541-84061b56acec", "body": "{\n \"detail\": \"You did not provide correct credentials.\",\n \"instance\": \"f94b4e56604e07e5e5ad5a7228618f81\",\n \"title\": \"Unauthorized\",\n \"type\": \"https://developer.nexmo.com/api-errors#unauthorized\"\n}", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "44a85044-d0a7-468b-b6a7-85dcc4dc9fdb", "body": "{\n \"detail\": \"Report aaaaaaaa-bbbb-cccc-dddd-0123456789ab does not exist, or you do not have access.\",\n \"instance\": \"f94b4e56604e07e5e5ad5a7228618f81\",\n \"title\": \"Invalid report ID\",\n \"type\": \"https://developer.nexmo.com/api-errors#not-found\"\n}", "latency": 0, "statusCode": 404, "label": "Not found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" } ], "proxyMode": false, "proxyHost": "", "proxyRemovePrefix": false, "tlsOptions": { "enabled": false, "type": "CERT", "pfxPath": "", "certPath": "", "keyPath": "", "caPath": "", "passphrase": "" }, "cors": true, "headers": [], "proxyReqHeaders": [{ "key": "", "value": "" }], "proxyResHeaders": [{ "key": "", "value": "" }], "data": [], "folders": [], "rootChildren": [ { "type": "route", "uuid": "b28d4d5b-5e71-4244-bd12-3f0f9f625495" }, { "type": "route", "uuid": "4980c238-4ca4-44b1-a8f6-87e07bd8b47f" }, { "type": "route", "uuid": "6e9e80f2-4d6c-4a22-9800-dab20c3f2586" }, { "type": "route", "uuid": "c0572c62-ba58-4907-9d84-0cd171d9b1b7" }, { "type": "route", "uuid": "c30f31b0-faff-4006-a1af-9bc8132a2d25" }, { "type": "route", "uuid": "5c055367-87bf-451e-9c10-112d00adfd66" } ] }