{ "uuid": "fbd92226-5c3e-48b9-9cc4-99dc2302569e", "lastMigration": 29, "name": "VisibleThread API", "endpointPrefix": "api/v1", "latency": 0, "port": 3000, "hostname": "", "routes": [ { "uuid": "fda03fc5-39ca-4c7e-9f38-722835674782", "documentation": "Get your list of dictionaries", "method": "get", "endpoint": "dictionaries", "responses": [ { "uuid": "6c608053-1447-4ae3-a27f-e0ae35791347", "body": "", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "705bdf58-a52e-44f8-a37e-6f778e4bf17e", "documentation": "Upload a dictionary (CSV)", "method": "post", "endpoint": "dictionaries", "responses": [ { "uuid": "4777a4cd-c3d9-485b-82da-6957a691914d", "body": "", "latency": 0, "statusCode": 200, "label": "Successful response", "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": "cc64e569-e29b-45e2-8448-8ec358af2ab3", "body": "", "latency": 0, "statusCode": 405, "label": "Invalid input", "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": "3ea6fe51-01bf-4c17-9bc7-e8becdc69a52", "documentation": "Get your list of documents", "method": "get", "endpoint": "documents", "responses": [ { "uuid": "3640c68a-af18-447f-aae7-b51dc3bea0e1", "body": "[\n {\n \"id\": {{faker 'number.int' max=99999}},\n \"name\": \"My Document.pdf\"\n }\n]", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f8075878-c55a-4c63-b9dc-da47b50d280e", "documentation": "Upload a document", "method": "post", "endpoint": "documents", "responses": [ { "uuid": "76c4669b-e412-42a4-8986-8fdae524e7c9", "body": "{\n \"docId\": {{faker 'number.int' max=99999}},\n \"scanSettings\": {\n \"longSentenceWordCount\": {{faker 'number.int' max=99999}},\n \"veryLongSentenceWordCount\": {{faker 'number.int' max=99999}}\n },\n \"task\": \"parse\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "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": "12c05e41-5ddd-42e9-9ef8-e988e5512de0", "body": "", "latency": 0, "statusCode": 405, "label": "Invalid input", "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": "246a0364-fc93-444f-9849-cc7436646580", "body": "", "latency": 0, "statusCode": 413, "label": "The document exceeds the maximum supported file size (15mb)", "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": "9b906bc9-4277-49f2-9058-358680081514", "documentation": "Get data from a previously submitted document", "method": "get", "endpoint": "documents/:docId", "responses": [ { "uuid": "bdbf4758-1129-404b-b7de-7b6ce43fb939", "body": "{\n \"completed\": \"{{faker 'date.recent' 365}}\",\n \"eta\": \"{{faker 'date.recent' 365}}\",\n \"id\": {{faker 'number.int' max=99999}},\n \"paragraphs\": [\n {\n \"paragraphCounter\": 12,\n \"paragraphIndex\": 22,\n \"stats\": {\n \"adverbs\": [\n [\n {\n \"end\": 399,\n \"start\": 386,\n \"text\": \"exceptionally\"\n }\n ]\n ],\n \"hiddenVerbs\": [\n [\n {\n \"end\": 210,\n \"noun\": \"investment\",\n \"start\": 185,\n \"text\": \"investment in intangibles\"\n }\n ]\n ],\n \"longSentences\": [\n [\n {\n \"end\": 130,\n \"start\": {{faker 'number.int' max=99999}},\n \"wordCount\": 22\n }\n ]\n ],\n \"passives\": [\n [\n {\n \"end\": 47,\n \"passivePiece\": \"was extracted\",\n \"start\": 34,\n \"verb\": \"extracted\"\n }\n ]\n ],\n \"veryLongSentences\": [\n [\n {\n \"end\": 130,\n \"start\": {{faker 'number.int' max=99999}},\n \"wordCount\": 34\n }\n ]\n ]\n },\n \"text\": \"This is an exmaple sentence which was extracted from a web page during a scan previously run using the VisibleThread API service. This is a short, simple sentence.\"\n }\n ],\n \"scanSettings\": {\n \"longSentenceWordCount\": {{faker 'number.int' max=99999}},\n \"veryLongSentenceWordCount\": {{faker 'number.int' max=99999}}\n },\n \"started\": \"{{faker 'date.recent' 365}}\",\n \"stats\": {\n \"avgSentenceLength\": {{faker 'number.int' max=99999}},\n \"fleschKincaidGradeLevel\": {{faker 'number.float'}},\n \"fleschReadingLevel\": {{faker 'number.int' max=99999}},\n \"longSentenceCount\": {{faker 'number.int' max=99999}},\n \"passiveSentenceCount\": {{faker 'number.int' max=99999}},\n \"sentenceCount\": {{faker 'number.int' max=99999}},\n \"wordCount\": {{faker 'number.int' max=99999}}\n },\n \"title\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "document response contained readability details for the document", "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": "29df2465-c2b4-46d5-89b6-be99a6f233b6", "body": "", "latency": 0, "statusCode": 404, "label": "document 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": "ab036842-47c1-4b0e-8a44-d7ef9ccc74c6", "body": "", "latency": 0, "statusCode": 415, "label": "the document is an unsupported file type", "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": "51f46808-d0eb-4197-9a71-43351a2c19bd", "body": "", "latency": 0, "statusCode": 500, "label": "an unknown error occurred processing the document", "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": "6603affa-47ae-4d41-b613-33b605ed189d", "body": "{\n \"eta\": \"{{faker 'date.recent' 365}}\",\n \"id\": {{faker 'number.int' max=99999}},\n \"started\": \"{{faker 'date.recent' 365}}\"\n}", "latency": 0, "statusCode": 503, "label": "the document analysis has not yet completed, try again later", "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": "7e7a9b16-9791-4b6b-aa8c-cb67d62b9b85", "documentation": "Get your list of searches", "method": "get", "endpoint": "searches", "responses": [ { "uuid": "b31080cf-1980-43b8-9e37-18977350dc6f", "body": "", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "9b210af9-596f-4ca3-a6d8-3cea19e4c306", "documentation": "Run a search", "method": "post", "endpoint": "searches", "responses": [ { "uuid": "104acebd-f242-4499-9199-c5caaef20938", "body": "", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "text/plain" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "485a2481-c8b0-48a8-9041-327f619c3d41", "body": "", "latency": 0, "statusCode": 405, "label": "Invalid input", "headers": [{ "key": "Content-Type", "value": "text/plain" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d366fd27-262c-4cdb-8b89-1adff060f51b", "documentation": "Gets search results for a particular document/dictionary", "method": "get", "endpoint": "searches/:docId/:dictionaryId", "responses": [ { "uuid": "10db423d-1281-46ac-aebb-76c2d39d057a", "body": "", "latency": 0, "statusCode": 200, "label": "scan response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c227dc80-e8ff-4b00-bad2-4fcb68957fab", "documentation": "Get your list of scans", "method": "get", "endpoint": "webscans", "responses": [ { "uuid": "500c3258-8b78-46b5-ae39-d2a3012e6ba6", "body": "[\n {\n \"completed\": \"{{faker 'date.recent' 365}}\",\n \"eta\": \"{{faker 'date.recent' 365}}\",\n \"id\": {{faker 'number.int' max=99999}},\n \"scan\": {\n \"title\": \"My fancy scan title\",\n \"webUrls\": [\n {\n \"id\": {{faker 'number.int' max=99999}},\n \"url\": \"http://visiblethread.com\"\n }\n ]\n },\n \"started\": \"{{faker 'date.recent' 365}}\"\n }\n]", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "80689f27-a06a-48ba-abb1-9f4f9328ee7f", "documentation": "Run a new scan", "method": "post", "endpoint": "webscans", "responses": [ { "uuid": "910c927e-a80c-4cf9-9fb9-3c5655891d94", "body": "{\n \"id\": 56487,\n \"title\": \"My fancy scan title\",\n \"webUrls\": [\n {\n \"id\": 88596,\n \"url\": \"http://visiblethread.com\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "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": "d6bed7aa-a00a-4aff-a15c-f1f7c09b486a", "body": "", "latency": 0, "statusCode": 405, "label": "Invalid input", "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": "057541dd-d0ef-491d-b831-2e7b679e21ae", "documentation": "Get data from a previously run scan", "method": "get", "endpoint": "webscans/:scanId", "responses": [ { "uuid": "6c19a28b-1b4f-49eb-8bfb-4ddbc9121084", "body": "{\n \"completed\": \"{{faker 'date.recent' 365}}\",\n \"eta\": \"{{faker 'date.recent' 365}}\",\n \"id\": {{faker 'number.int' max=99999}},\n \"scan\": {\n \"stats\": {\n \"avgSentenceLength\": {{faker 'number.int' max=99999}},\n \"fleschKincaidGradeLevel\": {{faker 'number.float'}},\n \"fleschReadingLevel\": {{faker 'number.int' max=99999}},\n \"longSentenceCount\": {{faker 'number.int' max=99999}},\n \"passiveSentenceCount\": {{faker 'number.int' max=99999}},\n \"sentenceCount\": {{faker 'number.int' max=99999}},\n \"wordCount\": {{faker 'number.int' max=99999}}\n },\n \"title\": \"My fancy scan title\",\n \"webUrls\": [\n {\n \"id\": {{faker 'number.int' max=99999}},\n \"url\": \"http://visiblethread.com\"\n }\n ]\n },\n \"started\": \"{{faker 'date.recent' 365}}\"\n}", "latency": 0, "statusCode": 200, "label": "scan response", "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": "dd32c50b-102d-4680-9f41-9386df1eff55", "body": "", "latency": 0, "statusCode": 404, "label": "webscan 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": "8f2f7f95-ccef-4581-8a3d-12b8ed1e7cb4", "body": "{\n \"eta\": \"{{faker 'date.recent' 365}}\",\n \"id\": {{faker 'number.int' max=99999}},\n \"started\": \"{{faker 'date.recent' 365}}\"\n}", "latency": 0, "statusCode": 503, "label": "the web analysis has not yet completed, try again later", "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": "98851a86-1558-43d5-9600-a3fd500879cc", "documentation": "Gets data for a particular scan/webUrl", "method": "get", "endpoint": "webscans/:scanId/webUrls/:urlId", "responses": [ { "uuid": "6440cf96-4c03-45ae-86b5-fc6316204032", "body": "{\n \"paragraphs\": [\n {\n \"paragraphCounter\": 12,\n \"paragraphIndex\": 22,\n \"stats\": {\n \"adverbs\": [\n [\n {\n \"end\": 399,\n \"start\": 386,\n \"text\": \"exceptionally\"\n }\n ]\n ],\n \"hiddenVerbs\": [\n [\n {\n \"end\": 210,\n \"noun\": \"investment\",\n \"start\": 185,\n \"text\": \"investment in intangibles\"\n }\n ]\n ],\n \"longSentences\": [\n [\n {\n \"end\": 130,\n \"start\": {{faker 'number.int' max=99999}},\n \"wordCount\": 22\n }\n ]\n ],\n \"passives\": [\n [\n {\n \"end\": 47,\n \"passivePiece\": \"was extracted\",\n \"start\": 34,\n \"verb\": \"extracted\"\n }\n ]\n ],\n \"veryLongSentences\": [\n [\n {\n \"end\": 130,\n \"start\": {{faker 'number.int' max=99999}},\n \"wordCount\": 34\n }\n ]\n ]\n },\n \"text\": \"This is an exmaple sentence which was extracted from a web page during a scan previously run using the VisibleThread API service. This is a short, simple sentence.\"\n }\n ],\n \"stats\": {\n \"avgSentenceLength\": {{faker 'number.int' max=99999}},\n \"fleschKincaidGradeLevel\": {{faker 'number.float'}},\n \"fleschReadingLevel\": {{faker 'number.int' max=99999}},\n \"longSentenceCount\": {{faker 'number.int' max=99999}},\n \"passiveSentenceCount\": {{faker 'number.int' max=99999}},\n \"sentenceCount\": {{faker 'number.int' max=99999}},\n \"wordCount\": {{faker 'number.int' max=99999}}\n },\n \"title\": \"My fancy scan title\",\n \"url\": \"http://visiblethread.com\"\n}", "latency": 0, "statusCode": 200, "label": "scan response", "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": "493f7051-8167-47f2-8168-6c1e2481751d", "body": "", "latency": 0, "statusCode": 404, "label": "scan url 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": "fda03fc5-39ca-4c7e-9f38-722835674782" }, { "type": "route", "uuid": "705bdf58-a52e-44f8-a37e-6f778e4bf17e" }, { "type": "route", "uuid": "3ea6fe51-01bf-4c17-9bc7-e8becdc69a52" }, { "type": "route", "uuid": "f8075878-c55a-4c63-b9dc-da47b50d280e" }, { "type": "route", "uuid": "9b906bc9-4277-49f2-9058-358680081514" }, { "type": "route", "uuid": "7e7a9b16-9791-4b6b-aa8c-cb67d62b9b85" }, { "type": "route", "uuid": "9b210af9-596f-4ca3-a6d8-3cea19e4c306" }, { "type": "route", "uuid": "d366fd27-262c-4cdb-8b89-1adff060f51b" }, { "type": "route", "uuid": "c227dc80-e8ff-4b00-bad2-4fcb68957fab" }, { "type": "route", "uuid": "80689f27-a06a-48ba-abb1-9f4f9328ee7f" }, { "type": "route", "uuid": "057541dd-d0ef-491d-b831-2e7b679e21ae" }, { "type": "route", "uuid": "98851a86-1558-43d5-9600-a3fd500879cc" } ] }