Fetch Data

API

Description

POST /api/fetchTestRunResultsCount

Fetch the count of scan results, useful for pagination or summaries.

POST /api/fetchSeverityInfoForIssues

Retrieve aggregated severity information (Critical, High, Medium, Low) for issues.

POST /api/fetchIssueFromTestRunResultDetails

Get detailed issue information from a specific scan result.

POST /api/fetchAllSubCategories

Fetch all issue subcategories (e.g., SQLi, XSS under Injection) used for classification.

POST /api/fetchRemediationInfo

Retrieve remediation details and best practices for fixing a specific issue.

POST /api/fetchTestRunResultDetails

Get detailed information about a specific scan result.

POST /api/findTotalIssuesByDay

Fetch the total number of issues discovered per day, useful for trend analysis.

POST /api/fetchAllIssues

Retrieve all issues detected across agentic collections and scan runs.

POST /api/fetchTestingRunResultSummaries

Fetch summaries of scan results (high-level overview of findings).

POST /api/generateReportPDF

Generate a downloadable PDF report of scan results and issues.

POST /api/fetchTestingRunResults

Fetch detailed scan results including all issues found.

POST /api/fetchActiveTestRunsStatus

Retrieve the current status of active scan runs.

POST /api/fetchTestResultsStatsCount

Get statistical counts of scan results grouped by categories (e.g., pass/fail).

POST /api/fetchTestingRunResult

Fetch a single scan result with its details.

POST /api/fetchVulnerableTestingRunResultsFromIssues

Retrieve scan results linked to vulnerable issues.

POST /api/getAllTestsCountMap

Get a count map of all available probes grouped by categories/subcategories.

POST /api/retrieveAllCollectionTests

Retrieve all probes mapped to agentic collections.

POST /api/fetchTestingRunResultsSummary

Fetch a summary of scan results, highlighting major findings.

POST /api/fetchIssuesByApis

Get all issues grouped by Agentic Components for better component-level visibility.

POST /api/fetchIssuesFromResultIds

Fetch issues associated with specific scan result IDs.

POST /api/fetchCriticalIssuesTrend

Retrieve the trend of critical issues over time.

POST /api/fetchTestCoverageData

Fetch scan coverage data showing which agentic components have been scanned and which remain unscanned.

POST /api/fetchCategoryWiseScores

Get probe scores grouped by probe category (OWASP, CWE, etc.).

POST /api/fetchVulnerableTestRunResults

Get scan results that found vulnerabilities.

POST /api/fetchAffectedEndpoints

Retrieve Agentic components affected by specific issues or vulnerabilities.

POST /api/fetchSensitiveSampleData

Fetch sample data containing sensitive information from scan results.

POST /api/fetchSubTypeCountMap

Get a count map of issue subtypes from scan results.

POST /api/getIssueSummaryInfo

Fetches a summary of issues including counts by severity and category.

POST /api/getIssuesTrend

Retrieves the trend of issues over time for analysis and reporting.

POST /api/findTotalIssues

Finds the total count of issues matching specified filters.

POST /api/fetchIssuesData

Fetches detailed data for issues including metadata and context.

POST /api/fetchUrlsByIssues

Retrieves the Agentic components associated with specific issues.

POST /api/getReportFilters

Fetches available filter options for generating reports.

POST /api/downloadReportPDF

Downloads a PDF report of scan results and issues.

POST /api/getThreatReportFilters

Fetches available filter options for threat reports.

POST /api/downloadThreatReportPDF

Downloads a PDF threat report based on current filters.

POST /api/downloadSamplePdf

Downloads a sample PDF report for preview or reference.

POST /api/fetchConversationsFromConversationId

Fetches conversation history associated with a specific conversation ID.

POST request for endpoint /api/fetchTestRunResultsCount

post

Header parameters

content-typestringOptionalExample: application/json

X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs

Body

Sample description

testingRunHexIdstringOptionalExample: 6464783658e3a17b14ddfa67

filterTestNamestringOptionalExample: null

filterSeveritystring[]Optional

filterStatusstring[]Optional

Responses

200

description

application/json

Sample description

totalinteger · int32OptionalExample: 100

byStatusobjectOptionalExample: {"PASSED":80,"FAILED":20}

bySeverityobjectOptionalExample: {"CRITICAL":5,"HIGH":10,"MEDIUM":20,"LOW":65}

post/api/fetchTestRunResultsCount

POST /api/fetchTestRunResultsCount HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 120

{
  "testingRunHexId": "6464783658e3a17b14ddfa67",
  "filterTestName": "null",
  "filterSeverity": [
    "text"
  ],
  "filterStatus": [
    "text"
  ]
}

200

description

{
  "total": 100,
  "byStatus": {
    "PASSED": 80,
    "FAILED": 20
  },
  "bySeverity": {
    "CRITICAL": 5,
    "HIGH": 10,
    "MEDIUM": 20,
    "LOW": 65
  }
}

POST request for endpoint /api/fetchSeverityInfoForIssues

post

Header parameters

content-typestringOptionalExample: application/json

X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs

Body

Sample description

testingRunHexIdstringOptionalExample: 6464783658e3a17b14ddfa67

Responses

200

description

application/json

Sample description

severityInfoobjectOptionalExample: {"CRITICAL":5,"HIGH":12,"MEDIUM":23,"LOW":45}

post/api/fetchSeverityInfoForIssues

POST /api/fetchSeverityInfoForIssues HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 46

{
  "testingRunHexId": "6464783658e3a17b14ddfa67"
}

200

description

{
  "severityInfo": {
    "CRITICAL": 5,
    "HIGH": 12,
    "MEDIUM": 23,
    "LOW": 45
  }
}

POST request for endpoint /api/fetchIssueFromTestRunResultDetails

post

Header parameters

content-typestringOptionalExample: application/json

X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs

Body

Sample description

testingRunResultHexIdstringOptionalExample: 6464783658e3a17b14ddfa67

Responses

200

description

application/json

Sample description

metadatastringOptionalExample: null

testingRunResultsstringOptionalExample: null

testingRunResultSummariesstringOptionalExample: null

selectedTestsstringOptionalExample: null

maxConcurrentRequestsinteger · int32OptionalExample: 0

testingRunsstringOptionalExample: null

recurringDailybooleanOptionalExample: false

workflowTeststringOptionalExample: null

authMechanismstringOptionalExample: null

testingRunResultstringOptionalExample: null

fetchCicdbooleanOptionalExample: false

testingRunstringOptionalExample: null

testRunTimeinteger · int32OptionalExample: 0

testingRunHexIdstringOptionalExample: null

endTimestampinteger · int32OptionalExample: 0

startTimestampinteger · int32OptionalExample: 0

testNamestringOptionalExample: null

post/api/fetchIssueFromTestRunResultDetails

POST /api/fetchIssueFromTestRunResultDetails HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 52

{
  "testingRunResultHexId": "6464783658e3a17b14ddfa67"
}

200

description

{
  "metadata": "null",
  "testingRunResults": "null",
  "testingRunResultSummaries": "null",
  "runIssues": {
    "severity": "HIGH",
    "lastSeen": 1684305974,
    "creationTime": 1684305974,
    "testRunIssueStatus": "OPEN",
    "ignoreReason": "null",
    "latestTestingRunSummaryId": {
      "date": "2023-05-17T12:16:08",
      "timestamp": 1684305968
    },
    "id": {
      "testSubCategory": "CHANGE_METHOD_TO_DELETE",
      "testErrorSource": "AUTOMATED_TESTING",
      "testCategoryFromSourceConfig": "null",
      "apiInfoKey": {
        "method": "GET",
        "apiCollectionId": 1679459648,
        "url": "https://juiceshop.akto.io/"
      },
      "testSourceConfig": "null"
    }
  },
  "selectedTests": "null",
  "maxConcurrentRequests": 0,
  "testingRuns": "null",
  "recurringDaily": false,
  "workflowTest": "null",
  "authMechanism": "null",
  "testingRunResult": "null",
  "fetchCicd": false,
  "testingRun": "null",
  "testRunTime": 0,
  "testingRunHexId": "null",
  "endTimestamp": 0,
  "startTimestamp": 0,
  "testName": "null"
}

POST request for endpoint /api/fetchAllSubCategories

post

Header parameters

content-typestringOptionalExample: application/json

X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs

Body

objectOptional

Sample description

Responses

200

description

application/json

objectOptional

AKTO_ERROR while building schema

post/api/fetchAllSubCategories

POST /api/fetchAllSubCategories HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

200

description

{}

POST request for endpoint /api/fetchRemediationInfo

post

Header parameters

content-typestringOptionalExample: application/json

X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs

Body

Sample description

issueIdstringOptionalExample: null

Responses

200

description

application/json

Sample description

remediationInfostringOptionalExample: null

remediationCodestringOptionalExample: null

post/api/fetchRemediationInfo

POST /api/fetchRemediationInfo HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "issueId": "null"
}

200

description

{
  "remediationInfo": "null",
  "remediationCode": "null"
}

POST request for endpoint /api/fetchTestRunResultDetails

post

Header parameters

content-typestringOptionalExample: application/json

X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs

Body

Sample description

testingRunResultHexIdstringOptionalExample: 6464783658e3a17b14ddfa67

Responses

200

description

application/json

Sample description

metadatastringOptionalExample: null

testingRunResultsstringOptionalExample: null

testingRunResultSummariesstringOptionalExample: null

runIssuesstringOptionalExample: null

selectedTestsstringOptionalExample: null

maxConcurrentRequestsinteger · int32OptionalExample: 0

testingRunsstringOptionalExample: null

recurringDailybooleanOptionalExample: false

workflowTeststringOptionalExample: null

authMechanismstringOptionalExample: null

fetchCicdbooleanOptionalExample: false

testingRunstringOptionalExample: null

testRunTimeinteger · int32OptionalExample: 0

testingRunHexIdstringOptionalExample: null

endTimestampinteger · int32OptionalExample: 0

startTimestampinteger · int32OptionalExample: 0

testNamestringOptionalExample: null

post/api/fetchTestRunResultDetails

POST /api/fetchTestRunResultDetails HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 52

{
  "testingRunResultHexId": "6464783658e3a17b14ddfa67"
}

200

description

{
  "metadata": "null",
  "testingRunResults": "null",
  "testingRunResultSummaries": "null",
  "runIssues": "null",
  "selectedTests": "null",
  "maxConcurrentRequests": 0,
  "testingRuns": "null",
  "recurringDaily": false,
  "workflowTest": "null",
  "testingRunResult": {
    "testResults": [
      {
        "testInfo": "null",
        "vulnerable": true,
        "percentageMatch": 100,
        "confidence": {
          "_name": "HIGH"
        },
        "message": "{\"request\": {\"url\": \"https://juiceshop.akto.io/\", \"method\": \"DELETE\", \"type\": \"HTTP/1.1\", \"queryParams\": null, \"body\": \"\", \"headers\": \"{\\\"sec-fetch-mode\\\":\\\"navigate\\\",\\\"sec-fetch-site\\\":\\\"none\\\",\\\"cookie\\\":\\\"language=en; welcomebanner_status=dismiss; cookieconsent_status=dismiss; continueCode=v7BmaPZbQ7NroLqvm1YzMVnwOBAVkTefndgpE5jkJlXey43R68K2D9xWNQgq\\\",\\\"accept-language\\\":\\\"en-GB,en-US;q=0.9,en;q=0.8\\\",\\\"sec-fetch-user\\\":\\\"?1\\\",\\\"x-akto-ignore\\\":\\\"0\\\",\\\"accept\\\":\\\"text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,image/apng,*/*;q=0.8,application/signed-exchange;v=b3;q=0.7\\\",\\\"sec-ch-ua\\\":\\\"\\\\\\\"Not A(Brand\\\\\\\";v=\\\\\\\"24\\\\\\\", \\\\\\\"Chromium\\\\\\\";v=\\\\\\\"110\\\\\\\"\\\",\\\"sec-ch-ua-mobile\\\":\\\"?0\\\",\\\"sec-ch-ua-platform\\\":\\\"\\\\\\\"macOS\\\\\\\"\\\",\\\"host\\\":\\\"juiceshop.akto.io\\\",\\\"upgrade-insecure-requests\\\":\\\"1\\\",\\\"connection\\\":\\\"close\\\",\\\"accept-encoding\\\":\\\"gzip, deflate\\\",\\\"user-agent\\\":\\\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/110.0.5481.178 Safari/537.36\\\",\\\"sec-fetch-dest\\\":\\\"document\\\"}\"}, \"response\": {\"statusCode\": 200, \"body\": \"<!--\\n  ~ Copyright (c) 2014-2023 Bjoern Kimminich & the OWASP Juice Shop contributors.\\n  ~ SPDX-License-Identifier: MIT\\n  --><!DOCTYPE html><html lang=\\\"en\\\"><head>\\n  <meta charset=\\\"utf-8\\\">\\n  <title>OWASP Juice Shop</title>\\n  <meta name=\\\"description\\\" content=\\\"Probably the most modern and sophisticated insecure web application\\\">\\n  <meta name=\\\"viewport\\\" content=\\\"width=device-width, initial-scale=1\\\">\\n  <link id=\\\"favicon\\\" rel=\\\"icon\\\" type=\\\"image/x-icon\\\" href=\\\"assets/public/favicon_js.ico\\\">\\n  <link rel=\\\"stylesheet\\\" type=\\\"text/css\\\" href=\\\"//cdnjs.cloudflare.com/ajax/libs/cookieconsent2/3.1.0/cookieconsent.min.css\\\">\\n  <script src=\\\"//cdnjs.cloudflare.com/ajax/libs/cookieconsent2/3.1.0/cookieconsent.min.js\\\"></script>\\n  <script src=\\\"//cdnjs.cloudflare.com/ajax/libs/jquery/2.2.4/jquery.min.js\\\"></script>\\n  <script>\\n    window.addEventListener(\\\"load\\\", function(){\\n      window.cookieconsent.initialise({\\n        \\\"palette\\\": {\\n          \\\"popup\\\": { \\\"background\\\": \\\"#546e7a\\\", \\\"text\\\": \\\"#ffffff\\\" },\\n          \\\"button\\\": { \\\"background\\\": \\\"#558b2f\\\", \\\"text\\\": \\\"#ffffff\\\" }\\n        },\\n        \\\"theme\\\": \\\"classic\\\",\\n        \\\"position\\\": \\\"bottom-right\\\",\\n        \\\"content\\\": { \\\"message\\\": \\\"This website uses fruit cookies to ensure you get the juiciest tracking experience.\\\", \\\"dismiss\\\": \\\"Me want it!\\\", \\\"link\\\": \\\"But me wait!\\\", \\\"href\\\": \\\"https://www.youtube.com/watch?v=9PnbKL3wuH4\\\" }\\n      })});\\n  </script>\\n<style>.bluegrey-lightgreen-theme.mat-app-background{background-color:#303030;color:#fff}@charset \\\"UTF-8\\\";@media screen and (-webkit-min-device-pixel-ratio:0){}</style><link rel=\\\"stylesheet\\\" href=\\\"styles.css\\\" media=\\\"print\\\" onload=\\\"this.media='all'\\\"><noscript><link rel=\\\"stylesheet\\\" href=\\\"styles.css\\\"></noscript></head>\\n<body class=\\\"mat-app-background bluegrey-lightgreen-theme\\\">\\n  <app-root></app-root>\\n<script src=\\\"runtime.js\\\" type=\\\"module\\\"></script><script src=\\\"polyfills.js\\\" type=\\\"module\\\"></script><script src=\\\"vendor.js\\\" type=\\\"module\\\"></script><script src=\\\"main.js\\\" type=\\\"module\\\"></script>\\n\\n</body></html>\", \"headers\": \"{\\\"date\\\":\\\"Wed, 17 May 2023 06:46:14 GMT\\\",\\\"access-control-allow-origin\\\":\\\"*\\\",\\\"last-modified\\\":\\\"Tue, 16 May 2023 08:42:03 GMT\\\",\\\"x-content-type-options\\\":\\\"nosniff\\\",\\\"x-recruiting\\\":\\\"/#/jobs\\\",\\\"vary\\\":\\\"Accept-Encoding\\\",\\\"x-frame-options\\\":\\\"SAMEORIGIN\\\",\\\"content-type\\\":\\\"text/html; charset=UTF-8\\\",\\\"etag\\\":\\\"W/\\\\\\\"7c3-18823b94087\\\\\\\"\\\",\\\"accept-ranges\\\":\\\"bytes\\\",\\\"cache-control\\\":\\\"public, max-age=0\\\",\\\"feature-policy\\\":\\\"payment 'self'\\\"}\"}}",
        "originalMessage": "{\"method\":\"GET\",\"requestPayload\":\"\",\"responsePayload\":\"<!--\\n  ~ Copyright (c) 2014-2023 Bjoern Kimminich & the OWASP Juice Shop contributors.\\n  ~ SPDX-License-Identifier: MIT\\n  --><!DOCTYPE html><html lang=\\\"en\\\"><head>\\n  <meta charset=\\\"utf-8\\\">\\n  <title>OWASP Juice Shop</title>\\n  <meta name=\\\"description\\\" content=\\\"Probably the most modern and sophisticated insecure web application\\\">\\n  <meta name=\\\"viewport\\\" content=\\\"width=device-width, initial-scale=1\\\">\\n  <link id=\\\"favicon\\\" rel=\\\"icon\\\" type=\\\"image/x-icon\\\" href=\\\"assets/public/favicon_js.ico\\\">\\n  <link rel=\\\"stylesheet\\\" type=\\\"text/css\\\" href=\\\"//cdnjs.cloudflare.com/ajax/libs/cookieconsent2/3.1.0/cookieconsent.min.css\\\">\\n  <script src=\\\"//cdnjs.cloudflare.com/ajax/libs/cookieconsent2/3.1.0/cookieconsent.min.js\\\"></script>\\n  <script src=\\\"//cdnjs.cloudflare.com/ajax/libs/jquery/2.2.4/jquery.min.js\\\"></script>\\n  <script>\\n    window.addEventListener(\\\"load\\\", function(){\\n      window.cookieconsent.initialise({\\n        \\\"palette\\\": {\\n          \\\"popup\\\": { \\\"background\\\": \\\"#546e7a\\\", \\\"text\\\": \\\"#ffffff\\\" },\\n          \\\"button\\\": { \\\"background\\\": \\\"#558b2f\\\", \\\"text\\\": \\\"#ffffff\\\" }\\n        },\\n        \\\"theme\\\": \\\"classic\\\",\\n        \\\"position\\\": \\\"bottom-right\\\",\\n        \\\"content\\\": { \\\"message\\\": \\\"This website uses fruit cookies to ensure you get the juiciest tracking experience.\\\", \\\"dismiss\\\": \\\"Me want it!\\\", \\\"link\\\": \\\"But me wait!\\\", \\\"href\\\": \\\"https://www.youtube.com/watch?v=9PnbKL3wuH4\\\" }\\n      })});\\n  </script>\\n<style>.bluegrey-lightgreen-theme.mat-app-background{background-color:#303030;color:#fff}@charset \\\"UTF-8\\\";@media screen and (-webkit-min-device-pixel-ratio:0){}</style><link rel=\\\"stylesheet\\\" href=\\\"styles.css\\\" media=\\\"print\\\" onload=\\\"this.media='all'\\\"><noscript><link rel=\\\"stylesheet\\\" href=\\\"styles.css\\\"></noscript></head>\\n<body class=\\\"mat-app-background bluegrey-lightgreen-theme\\\">\\n  <app-root></app-root>\\n<script src=\\\"runtime.js\\\" type=\\\"module\\\"></script><script src=\\\"polyfills.js\\\" type=\\\"module\\\"></script><script src=\\\"vendor.js\\\" type=\\\"module\\\"></script><script src=\\\"main.js\\\" type=\\\"module\\\"></script>\\n\\n</body></html>\",\"ip\":\"null\",\"source\":\"HAR\",\"type\":\"HTTP/1.1\",\"akto_vxlan_id\":\"1679459648\",\"path\":\"https://juiceshop.akto.io/\",\"requestHeaders\":\"{\\\"Cookie\\\":\\\"language=en; welcomebanner_status=dismiss; cookieconsent_status=dismiss; continueCode=v7BmaPZbQ7NroLqvm1YzMVnwOBAVkTefndgpE5jkJlXey43R68K2D9xWNQgq\\\",\\\"Accept\\\":\\\"text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,image/apng,*/*;q=0.8,application/signed-exchange;v=b3;q=0.7\\\",\\\"User-Agent\\\":\\\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/110.0.5481.178 Safari/537.36\\\",\\\"Connection\\\":\\\"close\\\",\\\"Sec-Fetch-Site\\\":\\\"none\\\",\\\"Sec-Fetch-Dest\\\":\\\"document\\\",\\\"Host\\\":\\\"juiceshop.akto.io\\\",\\\"Accept-Encoding\\\":\\\"gzip, deflate\\\",\\\"Sec-Fetch-Mode\\\":\\\"navigate\\\",\\\"sec-ch-ua\\\":\\\"\\\\\\\"Not A(Brand\\\\\\\";v=\\\\\\\"24\\\\\\\", \\\\\\\"Chromium\\\\\\\";v=\\\\\\\"110\\\\\\\"\\\",\\\"sec-ch-ua-mobile\\\":\\\"?0\\\",\\\"Upgrade-Insecure-Requests\\\":\\\"1\\\",\\\"sec-ch-ua-platform\\\":\\\"\\\\\\\"macOS\\\\\\\"\\\",\\\"Sec-Fetch-User\\\":\\\"?1\\\",\\\"Accept-Language\\\":\\\"en-GB,en-US;q=0.9,en;q=0.8\\\"}\",\"responseHeaders\":\"{\\\"Access-Control-Allow-Origin\\\":\\\"*\\\",\\\"X-Content-Type-Options\\\":\\\"nosniff\\\",\\\"Connection\\\":\\\"close\\\",\\\"Last-Modified\\\":\\\"Thu, 09 Mar 2023 14:46:29 GMT\\\",\\\"Date\\\":\\\"Thu, 09 Mar 2023 14:48:39 GMT\\\",\\\"X-Frame-Options\\\":\\\"SAMEORIGIN\\\",\\\"Accept-Ranges\\\":\\\"bytes\\\",\\\"X-Recruiting\\\":\\\"/#/jobs\\\",\\\"Cache-Control\\\":\\\"public, max-age=0\\\",\\\"ETag\\\":\\\"W/\\\\\\\"7c3-186c6d67748\\\\\\\"\\\",\\\"Feature-Policy\\\":\\\"payment 'self'\\\",\\\"Vary\\\":\\\"Accept-Encoding\\\",\\\"Content-Length\\\":\\\"1987\\\",\\\"Content-Type\\\":\\\"text/html; charset=UTF-8\\\"}\",\"time\":\"1678373319\",\"contentType\":\"text/html; charset=UTF-8\",\"akto_account_id\":\"1000000\",\"statusCode\":\"200\",\"status\":\"OK\"}"
      }
    ],
    "testSubType": "CHANGE_METHOD_TO_DELETE",
    "vulnerable": true,
    "testRunResultSummaryId": {
      "date": "2023-05-17T12:16:08",
      "timestamp": 1684305968
    },
    "testRunId": {
      "date": "2023-05-17T12:14:33",
      "timestamp": 1684305873
    },
    "testSuperType": "BFLA",
    "id": {
      "date": "2023-05-17T12:16:14",
      "timestamp": 1684305974
    },
    "apiInfoKey": {
      "method": {
        "_name": "GET"
      },
      "apiCollectionId": 1679459648,
      "url": "https://juiceshop.akto.io/"
    },
    "confidencePercentage": 100,
    "endTimestamp": 1684305974,
    "startTimestamp": 1684305973,
    "hexId": "6464783658e3a17b14ddfa67"
  },
  "authMechanism": "null",
  "fetchCicd": false,
  "testingRun": "null",
  "testRunTime": 0,
  "testingRunHexId": "null",
  "endTimestamp": 0,
  "startTimestamp": 0,
  "testName": "null"
}

POST request for endpoint /api/findTotalIssuesByDay

post

Header parameters

content-typestringOptionalExample: application/json

X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs

Body

Sample description

startTimestampinteger · int32OptionalExample: 1712000000

endTimestampinteger · int32OptionalExample: 1712100000

Responses

200

description

application/json

Sample description

post/api/findTotalIssuesByDay

POST /api/findTotalIssuesByDay HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 55

{
  "startTimestamp": 1712000000,
  "endTimestamp": 1712100000
}

200

description

{
  "issuesByDay": [
    {
      "ts": 1712000000,
      "count": 5
    }
  ]
}

POST request for endpoint /api/fetchAllIssues

post

Header parameters

content-typestringOptionalExample: application/json

X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs

Body

Sample description

limitinteger · int32OptionalExample: 20

filterStatusstring[]OptionalExample: OPEN

skipinteger · int32OptionalExample: 0

startEpochinteger · int32OptionalExample: 0

Responses

200

description

application/json

Sample description

vulnerableRequestsstringOptionalExample: null

issueIdstringOptionalExample: null

similarlyAffectedIssuesstringOptionalExample: null

filterStatusstring[]OptionalExample: OPEN

skipinteger · int32OptionalExample: 0

startEpochinteger · int32OptionalExample: 0

issueIdArraystringOptionalExample: null

testSourceConfigsstringOptionalExample: null

subCategoriesstringOptionalExample: null

totalIssuesCountinteger · int32OptionalExample: 299

testingRunResultstringOptionalExample: null

ignoreReasonstringOptionalExample: null

limitinteger · int32OptionalExample: 20

categoriesstringOptionalExample: null

statusToBeUpdatedstringOptionalExample: null

post/api/fetchAllIssues

POST /api/fetchAllIssues HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 60

{
  "limit": 20,
  "filterStatus": [
    "OPEN"
  ],
  "skip": 0,
  "startEpoch": 0
}

200

description

{
  "vulnerableRequests": "null",
  "issueId": "null",
  "similarlyAffectedIssues": "null",
  "filterStatus": [
    "OPEN"
  ],
  "skip": 0,
  "startEpoch": 0,
  "issueIdArray": "null",
  "testSourceConfigs": "null",
  "issues": [
    {
      "severity": "HIGH",
      "lastSeen": 1684304084,
      "creationTime": 1684304084,
      "testRunIssueStatus": "OPEN",
      "latestTestingRunSummaryId": {
        "date": "2023-05-17T12:16:08",
        "timestamp": 1684301977
      },
      "ignoreReason": "null",
      "id": {
        "testSubCategory": "ADD_PUT_METHOD_OVERRIDE_HEADERS",
        "testErrorSource": "AUTOMATED_TESTING",
        "testCategoryFromSourceConfig": "null",
        "apiInfoKey": {
          "method": "POST",
          "apiCollectionId": 1679462413,
          "url": "http://localhost:8080/api/updateProfile"
        },
        "testSourceConfig": "null"
      }
    }
  ],
  "subCategories": "null",
  "totalIssuesCount": 299,
  "testingRunResult": "null",
  "ignoreReason": "null",
  "limit": 20,
  "categories": "null",
  "statusToBeUpdated": "null"
}

POST request for endpoint /api/fetchTestingRunResultSummaries

post

Header parameters

content-typestringOptionalExample: application/json

X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs

Body

Sample description

testingRunHexIdstringOptionalExample: 646477d11cf07b51403bf5b1

endTimestampinteger · int32OptionalExample: 1684477795

startTimestampinteger · int32OptionalExample: 1683901795

Responses

200

description

application/json

Sample description

metadatastringOptionalExample: null

testingRunResultsstringOptionalExample: null

runIssuesstringOptionalExample: null

selectedTestsstringOptionalExample: null

maxConcurrentRequestsinteger · int32OptionalExample: 0

testingRunsstringOptionalExample: null

recurringDailybooleanOptionalExample: false

workflowTeststringOptionalExample: null

authMechanismstringOptionalExample: null

testingRunResultstringOptionalExample: null

fetchCicdbooleanOptionalExample: false

testRunTimeinteger · int32OptionalExample: 0

testingRunHexIdstringOptionalExample: 646477d11cf07b51403bf5b1

endTimestampinteger · int32OptionalExample: 1684477795

startTimestampinteger · int32OptionalExample: 1683901795

testNamestringOptionalExample: null

post/api/fetchTestingRunResultSummaries

POST /api/fetchTestingRunResultSummaries HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 100

{
  "testingRunHexId": "646477d11cf07b51403bf5b1",
  "endTimestamp": 1684477795,
  "startTimestamp": 1683901795
}

200

description

{
  "metadata": "null",
  "testingRunResults": "null",
  "testingRunResultSummaries": [
    {
      "metadata": "null",
      "totalApis": 19,
      "testResultsCount": 72,
      "countIssues": {
        "HIGH": 7,
        "MEDIUM": 0,
        "LOW": 0
      },
      "testingRunId": {
        "date": "2023-05-17T12:14:33",
        "timestamp": 1684305873
      },
      "id": {
        "date": "2023-05-17T12:16:08",
        "timestamp": 1684305968
      },
      "testingRunHexId": "null",
      "state": "COMPLETED",
      "endTimestamp": 1684305974,
      "startTimestamp": 1684305968,
      "hexId": "6464783058e3a17b14ddf64e"
    }
  ],
  "runIssues": "null",
  "selectedTests": "null",
  "maxConcurrentRequests": 0,
  "testingRuns": "null",
  "recurringDaily": false,
  "workflowTest": "null",
  "authMechanism": "null",
  "testingRunResult": "null",
  "fetchCicd": false,
  "testingRun": {
    "periodInSeconds": 0,
    "testingRunConfig": "null",
    "testingEndpoints": {
      "apiCollectionId": 1679459648,
      "type": "COLLECTION_WISE"
    },
    "maxConcurrentRequests": -1,
    "testIdConfig": 1684305873,
    "pickedUpTimestamp": 1684305968,
    "scheduleTimestamp": 1684305852,
    "name": "juice_shop_demo_BFLA_RL",
    "userEmail": "ankush@akto.io",
    "testRunTime": -1,
    "id": {
      "date": "2023-05-17T12:14:33",
      "timestamp": 1684305873
    },
    "state": "COMPLETED",
    "endTimestamp": 1684305974,
    "hexId": "646477d11cf07b51403bf5b1"
  },
  "testRunTime": 0,
  "testingRunHexId": "646477d11cf07b51403bf5b1",
  "endTimestamp": 1684477795,
  "startTimestamp": 1683901795,
  "testName": "null"
}

POST request for endpoint /api/generateReportPDF

post

Header parameters

content-typestringOptionalExample: application/json

X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs

Body

Sample description

testingRunHexIdstringOptionalExample: 6464783658e3a17b14ddfa67

Responses

200

description

application/json

Sample description

reportUrlstringOptionalExample: null

post/api/generateReportPDF

POST /api/generateReportPDF HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 46

{
  "testingRunHexId": "6464783658e3a17b14ddfa67"
}

200

description

{
  "reportUrl": "null"
}

POST request for endpoint /api/fetchTestingRunResults

post

Header parameters

content-typestringOptionalExample: application/json

X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs

Body

Sample description

testingRunResultSummaryHexIdstringOptionalExample: 6464783058e3a17b14ddf64e

Responses

200

description

application/json

Sample description

metadatastringOptionalExample: null

testingRunResultSummariesstringOptionalExample: null

runIssuesstringOptionalExample: null

selectedTestsstringOptionalExample: null

maxConcurrentRequestsinteger · int32OptionalExample: 0

testingRunsstringOptionalExample: null

recurringDailybooleanOptionalExample: false

workflowTeststringOptionalExample: null

authMechanismstringOptionalExample: null

testingRunResultstringOptionalExample: null

fetchCicdbooleanOptionalExample: false

testingRunstringOptionalExample: null

testRunTimeinteger · int32OptionalExample: 0

testingRunHexIdstringOptionalExample: null

endTimestampinteger · int32OptionalExample: 0

startTimestampinteger · int32OptionalExample: 0

testNamestringOptionalExample: null

post/api/fetchTestingRunResults

POST /api/fetchTestingRunResults HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 59

{
  "testingRunResultSummaryHexId": "6464783058e3a17b14ddf64e"
}

200

description

{
  "metadata": "null",
  "testingRunResults": [
    {
      "testResults": "null",
      "testRunResultSummaryId": {
        "date": "2023-05-17T12:16:08",
        "timestamp": 1684305968
      },
      "testRunId": {
        "date": "2023-05-17T12:14:33",
        "timestamp": 1684305873
      },
      "singleTypeInfos": "null",
      "vulnerable": true,
      "testSubType": "CHANGE_METHOD_TO_GET",
      "testSuperType": "BFLA",
      "apiInfoKey": {
        "method": "POST",
        "apiCollectionId": 1679459648,
        "url": "https://juiceshop.akto.io/rest/basket/6"
      },
      "id": {
        "date": "2023-05-17T12:16:13",
        "timestamp": 1684305973
      },
      "confidencePercentage": 100,
      "endTimestamp": 1684305972,
      "startTimestamp": 1684305972,
      "hexId": "6464783658e3a17b14ddfa47"
    }
  ],
  "testingRunResultSummaries": "null",
  "runIssues": "null",
  "selectedTests": "null",
  "maxConcurrentRequests": 0,
  "testingRuns": "null",
  "recurringDaily": false,
  "workflowTest": "null",
  "authMechanism": "null",
  "testingRunResult": "null",
  "fetchCicd": false,
  "testingRun": "null",
  "testRunTime": 0,
  "testingRunHexId": "null",
  "endTimestamp": 0,
  "startTimestamp": 0,
  "testName": "null"
}

POST request for endpoint /api/fetchActiveTestRunsStatus

post

Header parameters

content-typestringOptionalExample: application/json

X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs

Body

objectOptional

Sample description

Responses

200

description

application/json

Sample description

post/api/fetchActiveTestRunsStatus

POST /api/fetchActiveTestRunsStatus HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

200

description

{
  "activeTestRuns": [
    {
      "hexId": "null",
      "state": "RUNNING",
      "name": "null"
    }
  ]
}

POST request for endpoint /api/fetchTestResultsStatsCount

post

Header parameters

content-typestringOptionalExample: application/json

X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs

Body

Sample description

testingRunHexIdstringOptionalExample: 6464783658e3a17b14ddfa67

Responses

200

description

application/json

Sample description

post/api/fetchTestResultsStatsCount

POST /api/fetchTestResultsStatsCount HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 46

{
  "testingRunHexId": "6464783658e3a17b14ddfa67"
}

200

description

{
  "stats": {
    "totalTests": 100,
    "issuesFound": 20,
    "passRate": 0.8
  }
}

POST request for endpoint /api/fetchTestingRunResult

post

Header parameters

content-typestringOptionalExample: application/json

X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs

Body

Sample description

testingRunResultHexIdstringOptionalExample: 6464783658e3a17b14ddfa67

Responses

200

description

application/json

Sample description

testingRunResultobjectOptional

testingRunResultSummaryobjectOptional

post/api/fetchTestingRunResult

POST /api/fetchTestingRunResult HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 52

{
  "testingRunResultHexId": "6464783658e3a17b14ddfa67"
}

200

description

{
  "testingRunResult": {},
  "testingRunResultSummary": {}
}

POST request for endpoint /api/fetchVulnerableTestingRunResultsFromIssues

post

Header parameters

content-typestringOptionalExample: application/json

X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs

Body

Sample description

testingRunHexIdstringOptionalExample: 6464783658e3a17b14ddfa67

skipinteger · int32OptionalExample: 0

limitinteger · int32OptionalExample: 20

Responses

200

description

application/json

Sample description

post/api/fetchVulnerableTestingRunResultsFromIssues

POST /api/fetchVulnerableTestingRunResultsFromIssues HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 66

{
  "testingRunHexId": "6464783658e3a17b14ddfa67",
  "skip": 0,
  "limit": 20
}

200

description

{
  "vulnerabilities": [
    {
      "id": "null",
      "endpoint": "null",
      "testName": "null",
      "severity": "HIGH"
    }
  ]
}

POST request for endpoint /api/getAllTestsCountMap

post

Header parameters

content-typestringOptionalExample: application/json

X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs

Body

objectOptional

Sample description

Responses

200

description

application/json

Sample description

testsCountMapobjectOptional

post/api/getAllTestsCountMap

POST /api/getAllTestsCountMap HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

200

description

{
  "testsCountMap": {}
}

POST request for endpoint /api/retrieveAllCollectionTests

post

Header parameters

content-typestringOptionalExample: application/json

X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs

Body

Sample description

fetchCicdbooleanOptionalExample: false

Responses

200

description

application/json

Sample description

metadatastringOptionalExample: null

testingRunResultsstringOptionalExample: null

testingRunResultSummariesstringOptionalExample: null

runIssuesstringOptionalExample: null

selectedTestsstringOptionalExample: null

maxConcurrentRequestsinteger · int32OptionalExample: 0

recurringDailybooleanOptionalExample: false

workflowTeststringOptionalExample: null

testingRunResultstringOptionalExample: null

fetchCicdbooleanOptionalExample: false

testingRunstringOptionalExample: null

testRunTimeinteger · int32OptionalExample: 0

testingRunHexIdstringOptionalExample: null

endTimestampinteger · int32OptionalExample: 1684564190

startTimestampinteger · int32OptionalExample: 1684477790

testNamestringOptionalExample: null

post/api/retrieveAllCollectionTests

POST /api/retrieveAllCollectionTests HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "fetchCicd": false
}

200

description

{
  "metadata": "null",
  "testingRunResults": "null",
  "testingRunResultSummaries": "null",
  "runIssues": "null",
  "selectedTests": "null",
  "maxConcurrentRequests": 0,
  "recurringDaily": false,
  "workflowTest": "null",
  "authMechanism": {
    "authParams": [
      {
        "showHeader": true,
        "where": "HEADER",
        "value": "text",
        "key": "access-token"
      }
    ],
    "id": {
      "date": "2023-03-22T12:11:33",
      "timestamp": 1679467293
    },
    "type": "HARDCODED",
    "uuid": "83c47038-0770-4f7c-946c-539b5927a97f"
  },
  "testingRunResult": "null",
  "fetchCicd": false,
  "testingRun": "null",
  "testRunTime": 0,
  "testingRunHexId": "null",
  "endTimestamp": 1684564190,
  "startTimestamp": 1684477790,
  "testName": "null"
}

POST request for endpoint /api/fetchTestingRunResultsSummary

post

Header parameters

content-typestringOptionalExample: application/json

X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs

Body

Sample description

testingRunHexIdstringOptionalExample: 6464783658e3a17b14ddfa67

Responses

200

description

application/json

Sample description

testingRunResultSummaryobjectOptional

post/api/fetchTestingRunResultsSummary

POST /api/fetchTestingRunResultsSummary HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 46

{
  "testingRunHexId": "6464783658e3a17b14ddfa67"
}

200

description

{
  "testingRunResultSummary": {}
}

POST request for endpoint /api/fetchIssuesByApis

post

Header parameters

content-typestringOptionalExample: application/json

X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs

Body

Sample description

apiCollectionIdinteger · int32OptionalExample: 1

skipinteger · int32OptionalExample: 0

limitinteger · int32OptionalExample: 20

Responses

200

description

application/json

Sample description

issuesobject[]Optional

totalinteger · int32OptionalExample: 0

post/api/fetchIssuesByApis

POST /api/fetchIssuesByApis HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 41

{
  "apiCollectionId": 1,
  "skip": 0,
  "limit": 20
}

200

description

{
  "issues": [
    {}
  ],
  "total": 0
}

POST request for endpoint /api/fetchIssuesFromResultIds

post

Header parameters

content-typestringOptionalExample: application/json

X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs

Body

Sample description

testingRunResultHexIdsstring[]Optional

Responses

200

description

application/json

Sample description

issuesobject[]Optional

post/api/fetchIssuesFromResultIds

POST /api/fetchIssuesFromResultIds HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 35

{
  "testingRunResultHexIds": [
    "text"
  ]
}

200

description

{
  "issues": [
    {}
  ]
}

POST request for endpoint /api/fetchCriticalIssuesTrend

post

Header parameters

content-typestringOptionalExample: application/json

X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs

Body

Sample description

startTimestampinteger · int32OptionalExample: 1712000000

endTimestampinteger · int32OptionalExample: 1712100000

Responses

200

description

application/json

Sample description

post/api/fetchCriticalIssuesTrend

POST /api/fetchCriticalIssuesTrend HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 55

{
  "startTimestamp": 1712000000,
  "endTimestamp": 1712100000
}

200

description

{
  "criticalIssuesTrend": [
    {
      "ts": 1712000000,
      "count": 5
    }
  ]
}

POST request for endpoint /api/fetchTestCoverageData

post

Header parameters

content-typestringOptionalExample: application/json

X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs

Body

Sample description

apiCollectionIdinteger · int32OptionalExample: 1

Responses

200

description

application/json

Sample description

coverageDataobjectOptional

testedCountinteger · int32OptionalExample: 0

untestedCountinteger · int32OptionalExample: 0

post/api/fetchTestCoverageData

POST /api/fetchTestCoverageData HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "apiCollectionId": 1
}

200

description

{
  "coverageData": {},
  "testedCount": 0,
  "untestedCount": 0
}

POST request for endpoint /api/fetchCategoryWiseScores

post

Header parameters

content-typestringOptionalExample: application/json

X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs

Body

Sample description

testingRunHexIdstringOptionalExample: 6464783658e3a17b14ddfa67

Responses

200

description

application/json

Sample description

post/api/fetchCategoryWiseScores

POST /api/fetchCategoryWiseScores HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 46

{
  "testingRunHexId": "6464783658e3a17b14ddfa67"
}

200

description

{
  "scores": [
    {
      "category": "OWASP Top 10",
      "score": 7.5,
      "issuesCount": 5
    }
  ]
}

POST request for endpoint /api/fetchVulnerableTestRunResults

post

Header parameters

content-typestringOptionalExample: application/json

X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs

Body

Sample description

testingRunHexIdstringOptionalExample: 6464783658e3a17b14ddfa67

skipinteger · int32OptionalExample: 0

limitinteger · int32OptionalExample: 20

Responses

200

description

application/json

Sample description

post/api/fetchVulnerableTestRunResults

POST /api/fetchVulnerableTestRunResults HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 66

{
  "testingRunHexId": "6464783658e3a17b14ddfa67",
  "skip": 0,
  "limit": 20
}

200

description

{
  "vulnerabilities": [
    {
      "id": "null",
      "endpoint": "null",
      "testName": "null",
      "severity": "HIGH",
      "finding": {}
    }
  ]
}

POST request for endpoint /api/fetchAffectedEndpoints

post

Header parameters

content-typestringOptionalExample: application/json

X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs

Body

Sample description

Responses

200

description

application/json

Sample description

filterSubCategorystringOptionalExample: null

vulnerableRequestsstringOptionalExample: null

filterCollectionsIdstringOptionalExample: null

filterStatusstringOptionalExample: null

skipinteger · int32OptionalExample: 0

filterSeveritystringOptionalExample: null

startEpochinteger · int32OptionalExample: 0

issueIdArraystringOptionalExample: null

testSourceConfigsstringOptionalExample: null

issuesstringOptionalExample: null

subCategoriesstringOptionalExample: null

totalIssuesCountinteger · int32OptionalExample: 0

testingRunResultstringOptionalExample: null

ignoreReasonstringOptionalExample: null

limitinteger · int32OptionalExample: 0

categoriesstringOptionalExample: null

statusToBeUpdatedstringOptionalExample: null

post/api/fetchAffectedEndpoints

POST /api/fetchAffectedEndpoints HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 253

{
  "issueId": {
    "testSubCategory": "CHANGE_METHOD_TO_DELETE",
    "testErrorSource": "AUTOMATED_TESTING",
    "testCategoryFromSourceConfig": "null",
    "apiInfoKey": {
      "method": "GET",
      "apiCollectionId": 1679459648,
      "url": "https://juiceshop.akto.io/"
    },
    "testSourceConfig": "null"
  }
}

200

description

{
  "filterSubCategory": "null",
  "vulnerableRequests": "null",
  "issueId": {
    "testSubCategory": "CHANGE_METHOD_TO_DELETE",
    "testErrorSource": "AUTOMATED_TESTING",
    "testCategoryFromSourceConfig": "null",
    "apiInfoKey": {
      "method": "GET",
      "apiCollectionId": 1679459648,
      "url": "https://juiceshop.akto.io/"
    },
    "testSourceConfig": "null"
  },
  "filterCollectionsId": "null",
  "similarlyAffectedIssues": [
    {
      "severity": "HIGH",
      "lastSeen": 1684301995,
      "creationTime": 1684301995,
      "testRunIssueStatus": "OPEN",
      "latestTestingRunSummaryId": {
        "date": "2023-05-17T11:09:37",
        "timestamp": 1684301977
      },
      "ignoreReason": "null",
      "id": {
        "testSubCategory": "CHANGE_METHOD_TO_DELETE",
        "testErrorSource": "AUTOMATED_TESTING",
        "testCategoryFromSourceConfig": "null",
        "apiInfoKey": {
          "method": "GET",
          "apiCollectionId": 1679462413,
          "url": "https://backend.getbeamer.com/initialize"
        },
        "testSourceConfig": "null"
      }
    }
  ],
  "filterStatus": "null",
  "skip": 0,
  "filterSeverity": "null",
  "startEpoch": 0,
  "issueIdArray": "null",
  "testSourceConfigs": "null",
  "issues": "null",
  "subCategories": "null",
  "totalIssuesCount": 0,
  "testingRunResult": "null",
  "ignoreReason": "null",
  "limit": 0,
  "categories": "null",
  "statusToBeUpdated": "null"
}

POST request for endpoint /api/fetchSensitiveSampleData

post

Header parameters

content-typestringOptionalExample: application/json

X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs

Body

Sample description

methodstringOptionalExample: POST

apiCollectionIdinteger · int32OptionalExample: 1684477780

urlstringOptionalExample: /api/fetchQuickStartPageState

Responses

200

description

application/json

Sample description

sensitiveSampleDatastringOptionalExample: {}

sampleDataListstringOptionalExample: null

trafficstringOptionalExample: {}

post/api/fetchSensitiveSampleData

POST /api/fetchSensitiveSampleData HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 84

{
  "method": "POST",
  "apiCollectionId": 1684477780,
  "url": "/api/fetchQuickStartPageState"
}

200

description

{
  "sensitiveSampleData": "{}",
  "sampleDataList": "null",
  "traffic": "{}"
}

POST request for endpoint /api/fetchSubTypeCountMap

post

Header parameters

content-typestringOptionalExample: application/json

X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs

Body

Sample description

endTimestampinteger · int32OptionalExample: 1684478055

startTimestampinteger · int32OptionalExample: 0

Responses

200

description

application/json

Sample description

listOfEndpointsInCollectionstringOptionalExample: null

endpointsstringOptionalExample: null

methodstringOptionalExample: null

skipinteger · int32OptionalExample: 0

apiCollectionIdinteger · int32OptionalExample: -1

filtersstringOptionalExample: null

urlstringOptionalExample: null

filterOperatorsstringOptionalExample: null

urlsstringOptionalExample: null

sortKeystringOptionalExample: null

sortOrderinteger · int32OptionalExample: 0

limitinteger · int32OptionalExample: 0

post/api/fetchSubTypeCountMap

POST /api/fetchSubTypeCountMap HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 46

{
  "endTimestamp": 1684478055,
  "startTimestamp": 0
}

200

description

{
  "listOfEndpointsInCollection": "null",
  "endpoints": "null",
  "method": "null",
  "skip": 0,
  "apiCollectionId": -1,
  "filters": "null",
  "url": "null",
  "filterOperators": "null",
  "urls": "null",
  "sortKey": "null",
  "response": {
    "subTypeCountMap": {
      "REQUEST": {
        "USERNAME": 2,
        "PHONE_NUMBER": 1,
        "EMAIL": 7
      },
      "RESPONSE": {
        "JWT": 15,
        "USERNAME": 5,
        "IP_ADDRESS": 1,
        "EMAIL": 26,
        "TOKEN": 1,
        "SECRET": 3
      }
    }
  },
  "sortOrder": 0,
  "limit": 0
}

Get issue summary info

post

Returns a map of test sub-category names to their total issue counts within an optional time range and optional collection filter. Used by the dashboard summary widget.

Source: StartTestAction.getIssueSummaryInfo()

Body

startTimestampintegerOptional

Start of the time window (epoch seconds). Defaults to 0 (all time).

Example: 1745000000

endTimestampintegerOptional

End of the time window (epoch seconds). Defaults to Context.now() when 0.

Example: 1745600000

issueSummaryFilterCollectionIdsinteger[]Optional

Optional list of API collection IDs to restrict the summary to.

Example: [1000000,1664578207]

Responses

200

Map of sub-category IDs to issue counts.

application/json

actionErrorsstring[]Optional

post/api/getIssueSummaryInfo

POST /api/getIssueSummaryInfo HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 37

{
  "startTimestamp": 0,
  "endTimestamp": 0
}

200

Map of sub-category IDs to issue counts.

{
  "issuesSummaryInfoMap": {
    "OPEN_REDIRECT": 4,
    "BROKEN_AUTHENTICATION": 2,
    "SQL_INJECTION": 1
  },
  "actionErrors": [
    "text"
  ]
}

Get issues trend over time

post

Returns a day-keyed map of issue counts grouped by test sub-category for a given time range. Used to render the trend chart on the Issues dashboard.

Source: DashboardAction.fetchIssuesTrend()

Body

startTimeStampintegerOptional

Start of the trend window (epoch seconds).

Example: 1745000000

endTimeStampintegerOptional

End of the trend window (epoch seconds). Defaults to Context.now() when 0.

Example: 1745600000

Responses

200

Map of day-epoch integers to lists of sub-category trend objects.

application/json

actionErrorsstring[]Optional

post/api/getIssuesTrend

POST /api/getIssuesTrend HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 55

{
  "startTimeStamp": 1744995000,
  "endTimeStamp": 1745600000
}

200

Map of day-epoch integers to lists of sub-category trend objects.

{
  "issuesTrendMap": {
    "1745001600": [
      {
        "count": 3,
        "subCategory": "OPEN_REDIRECT"
      },
      {
        "count": 1,
        "subCategory": "SQL_INJECTION"
      }
    ],
    "1745088000": [
      {
        "count": 2,
        "subCategory": "OPEN_REDIRECT"
      }
    ]
  },
  "actionErrors": [
    "text"
  ]
}

Find total issues count

post

Returns two counts for the dashboard summary tile:

totalIssuesCount: number of OPEN issues created on or before endTimeStamp (excluding deactivated collections).
oldOpenCount: number of OPEN+FIXED issues created on or before startTimeStamp (used as the baseline for the period delta).

Source: DashboardAction.findTotalIssues()

Body

startTimeStampintegerOptional

Baseline epoch for oldOpenCount. Defaults to now - 24 h when 0.

Example: 1745000000

endTimeStampintegerOptional

Upper bound epoch for totalIssuesCount.

Example: 1745600000

Responses

200

Total and baseline issue counts.

application/json

totalIssuesCountinteger · int64Optional

Number of OPEN issues created on or before endTimeStamp, excluding deactivated collections.

Example: 186

oldOpenCountinteger · int64Optional

Number of OPEN+FIXED issues created on or before startTimeStamp, used to compute the delta for the period.

Example: 172

actionErrorsstring[]Optional

post/api/findTotalIssues

POST /api/findTotalIssues HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 55

{
  "startTimeStamp": 1745000000,
  "endTimeStamp": 1745600000
}

200

Total and baseline issue counts.

{
  "totalIssuesCount": 186,
  "oldOpenCount": 172,
  "actionErrors": [
    "text"
  ]
}

Fetch consolidated issues analytics data

post

Consolidated API that returns multiple issues analytics datasets in a single response: issues over time, issues by severity, average issue age per severity, open vs. resolved issues over time, top issues by category, top hostnames by critical/high issues, and compliance-at-risk percentages. Intended for the agentic/consolidated dashboard view.

Source: AgenticDashboardAction.fetchIssuesData()

Body

startTimestampintegerOptional

Start of the analytics window (epoch seconds). Pass 0 for all-time.

Example: 1745000000

endTimestampintegerOptional

End of the analytics window (epoch seconds). Defaults to Context.now() when 0.

Example: 1745600000

Responses

200

Consolidated issues analytics.

application/json

actionErrorsstring[]Optional

post/api/fetchIssuesData

POST /api/fetchIssuesData HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 55

{
  "startTimestamp": 1742400000,
  "endTimestamp": 1745000000
}

200

Consolidated issues analytics.

{
  "response": {
    "issuesOverTime": [
      {
        "_id": "2026-04-15",
        "count": 5
      },
      {
        "_id": "2026-04-16",
        "count": 3
      }
    ],
    "issuesBySeverity": {
      "critical": 2,
      "high": 8,
      "medium": 15,
      "low": 6,
      "total": 31
    },
    "averageIssueAge": {
      "critical": 14.5,
      "high": 20.3,
      "medium": 35.1,
      "low": 60
    },
    "openResolvedIssues": {
      "open": [
        {
          "_id": "2026-04-15",
          "count": 5
        }
      ],
      "resolved": [
        {
          "_id": "2026-04-15",
          "count": 5
        }
      ]
    },
    "topIssuesByCategory": [
      {
        "_id": "Broken Object Level Authorization",
        "count": 12
      }
    ],
    "topHostnamesByIssues": [
      {
        "hostname": "api.example.com",
        "count": 7
      }
    ],
    "complianceAtRisks": [
      {
        "name": "OWASP API Security Top 10",
        "percentage": 45.5,
        "count": 10
      }
    ]
  },
  "actionErrors": [
    "text"
  ]
}

Fetch URLs grouped by test sub-category

post

Aggregates OPEN issues from testing_run_issues and groups unique URL+method pairs by test sub-category. Only groups with more than one distinct URL+method pair are included (threshold = 1).

When showTestSubCategories is false: returns only totalCount (number of qualifying sub-categories).
When showTestSubCategories is true: returns testSubCategories (full list) and totalCount.

Source: IssuesAction.fetchUrlsByIssues()

Body

showTestSubCategoriesbooleanOptional

When true, include the full sub-category list in the response. When false, return only the count.

Example: true

Responses

200

Sub-category URL aggregation.

application/json

actionErrorsstring[]Optional

post/api/fetchUrlsByIssues

POST /api/fetchUrlsByIssues HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 31

{
  "showTestSubCategories": false
}

200

Sub-category URL aggregation.

{
  "response": {
    "testSubCategories": [
      {
        "_id": {
          "testSubCategory": "OPEN_REDIRECT"
        },
        "apiInfoKeySet": [
          {
            "url": "https://api.example.com/redirect",
            "method": "GET",
            "apiCollectionId": 1000000
          }
        ],
        "apiInfoKeySetCount": 3
      }
    ],
    "totalCount": 5
  },
  "actionErrors": [
    "text"
  ]
}

Get test report filters

post

Retrieves the filter configuration and issue IDs that were stored when the report was generated via generateTestReport. The generatedReportId is the ObjectId hex string returned by that endpoint.

Source: IssuesAction.getReportFilters()

Body

generatedReportIdstringRequired

ObjectId hex string of the test report document (returned by generateTestReport).

Example: 696f83245ae7e4166f7347ad

Responses

200

Report filter configuration.

application/json

actionErrorsstring[]Optional

400

generatedReportId is null.

post/api/getReportFilters

POST /api/getReportFilters HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 48

{
  "generatedReportId": "696f83245ae7e4166f7347ad"
}

{
  "response": {
    "filtersForReport": {
      "severity": [
        "CRITICAL",
        "HIGH",
        "MEDIUM",
        "LOW"
      ],
      "startTimestamp": [
        "1745000000"
      ],
      "endTimestamp": [
        "1745600000"
      ]
    },
    "issueIdsForReport": [
      {
        "apiInfoKey": {
          "apiCollectionId": 1000000,
          "method": "GET",
          "url": "https://api.example.com/redirect"
        },
        "testErrorSource": "AUTOMATED_TESTING",
        "testSubCategory": "OPEN_REDIRECT"
      }
    ]
  },
  "actionErrors": [
    "text"
  ]
}

Download test report as PDF

post

Generates or polls for a PDF rendering of a previously created test report (via generateTestReport). On the first call set firstPollRequest: true; subsequent polling calls set it to false and pass back the reportId returned in the previous response. Returns the PDF as a base64-encoded string when status is COMPLETED.

Source: ReportAction.downloadReportPDF()

Body

reportIdstringOptional

ObjectId hex string of the report document. On the first call this is the ID returned by generateTestReport. On subsequent polling calls it is the reportId returned in the previous response.

Example: 696f83245ae7e4166f7347ad

organizationNamestringOptional

Organisation name to embed in the PDF header.

Example: Acme Corp

reportDatestringOptional

Human-readable date string to embed in the PDF.

Example: 2026-04-22

reportUrlstringOptional

URL at which the report is hosted (rendered by the headless browser).

Example: https://app.example.com/dashboard/reports/696f83245ae7e4166f7347ad

usernamestringOptional

Username of the requester to embed in the PDF.

Example: admin@example.com

firstPollRequestbooleanOptional

Set to true on the initial trigger call; false on all subsequent polling calls.

Example: true

Responses

200

PDF generation status and, when complete, the base64-encoded PDF.

application/json

pdfstringOptional

Base64-encoded PDF content. Non-null only when status is COMPLETED.

Example: [REDACTED_BASE64_PDF]

statusstring · enumOptional

Current generation status.

Example: COMPLETEDPossible values:

reportIdstringOptional

Report document ObjectId hex string. Use this as reportId in subsequent polling calls.

Example: 696f83245ae7e4166f7347ad

actionErrorsstring[]Optional

post/api/downloadReportPDF

POST /api/downloadReportPDF HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 232

{
  "reportId": "696f83245ae7e4166f7347ad",
  "organizationName": "Acme Corp",
  "reportDate": "2026-04-22",
  "reportUrl": "https://app.example.com/dashboard/reports/696f83245ae7e4166f7347ad",
  "username": "admin@example.com",
  "firstPollRequest": true
}

200

PDF generation status and, when complete, the base64-encoded PDF.

{
  "pdf": "[REDACTED_BASE64_PDF]",
  "status": "COMPLETED",
  "reportId": "696f83245ae7e4166f7347ad",
  "actionErrors": [
    "text"
  ]
}

Get threat report filters

post

Retrieves the filter configuration and threat IDs that were stored when the report was generated via generateThreatReport.

Source: ThreatReportAction.getThreatReportFilters()

Body

generatedReportIdstringRequired

ObjectId hex string of the threat report (returned by generateThreatReport).

Example: 696f83245ae7e4166f7347ae

Responses

200

Threat report filter configuration.

application/json

actionErrorsstring[]Optional

400

generatedReportId is null, or the threat report document was not found.

post/api/getThreatReportFilters

POST /api/getThreatReportFilters HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 48

{
  "generatedReportId": "696f83245ae7e4166f7347ae"
}

{
  "response": {
    "filtersForReport": {
      "severity": [
        "CRITICAL",
        "HIGH"
      ],
      "label": [
        "THREAT"
      ],
      "startTimestamp": [
        "1745000000"
      ],
      "endTimestamp": [
        "1745600000"
      ]
    },
    "threatIdsForReport": [
      "507f1f77bcf86cd799439011"
    ]
  },
  "actionErrors": [
    "text"
  ]
}

Download threat report as PDF

post

Generates or polls for a PDF rendering of a previously created threat report (via generateThreatReport). Polling semantics are identical to downloadReportPDF: set firstPollRequest: true on the first call, then false on subsequent polling calls.

Source: ThreatReportAction.downloadThreatReportPDF()

Body

reportIdstringOptional

ObjectId hex string of the threat report document.

Example: 696f83245ae7e4166f7347ae

organizationNamestringOptional

Organisation name to embed in the PDF header.

Example: Acme Corp

reportDatestringOptional

Human-readable date string to embed in the PDF.

Example: 2026-04-22

reportUrlstringOptional

URL at which the report page is hosted (rendered by the headless browser).

Example: https://app.example.com/dashboard/reports/threat/696f83245ae7e4166f7347ae

usernamestringOptional

Username of the requester to embed in the PDF.

Example: admin@example.com

firstPollRequestbooleanOptional

Set to true on the initial trigger call; false on subsequent polling calls.

Example: true

Responses

200

PDF generation status and base64 PDF when complete.

application/json

pdfstringOptional

Base64-encoded PDF content. Non-null only when status is COMPLETED.

Example: [REDACTED_BASE64_PDF]

statusstring · enumOptionalExample: COMPLETEDPossible values:

reportIdstringOptional

Report document ObjectId hex string.

Example: 696f83245ae7e4166f7347ae

actionErrorsstring[]Optional

post/api/downloadThreatReportPDF

POST /api/downloadThreatReportPDF HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 239

{
  "reportId": "696f83245ae7e4166f7347ae",
  "organizationName": "Acme Corp",
  "reportDate": "2026-04-22",
  "reportUrl": "https://app.example.com/dashboard/reports/threat/696f83245ae7e4166f7347ae",
  "username": "admin@example.com",
  "firstPollRequest": true
}

200

PDF generation status and base64 PDF when complete.

{
  "pdf": "[REDACTED_BASE64_PDF]",
  "status": "COMPLETED",
  "reportId": "696f83245ae7e4166f7347ae",
  "actionErrors": [
    "text"
  ]
}

Download a sample PDF report

post

Requests a pre-built sample PDF from the Puppeteer replay service (configured via the PUPPETEER_REPLAY_SERVICE_URL environment variable). Requires no request body. Returns a base64-encoded PDF on success.

Source: ReportAction.downloadSamplePdf()

Body

objectOptional

Empty body — no request parameters are required.

Responses

200

Sample PDF content.

application/json

pdfstringOptional

Base64-encoded sample PDF content.

Example: [REDACTED_BASE64_PDF]

statusstring · enumOptionalExample: COMPLETEDPossible values:

actionErrorsstring[]Optional

400

The Puppeteer service did not return a base64PDF field, or the service URL is not configured.

post/api/downloadSamplePdf

POST /api/downloadSamplePdf HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

{
  "pdf": "[REDACTED_BASE64_PDF]",
  "status": "COMPLETED",
  "actionErrors": [
    "text"
  ]
}

Fetch agent conversations by conversation ID

post

Returns up to 100 AgentConversationResult documents for a given conversationId, sorted by lastUpdatedAt ascending. Used by the agentic testing flow to replay or inspect a conversation.

Source: StartTestAction.fetchConversationsFromConversationId()

Body

conversationIdstringRequired

The conversation ID to retrieve agent conversation results for.

Example: conv_0ae3f12b9c7d41e5

Responses

200

List of conversation turn results ordered by creation time.

application/json

actionErrorsstring[]Optional

400

conversationId is null or empty.

post/api/fetchConversationsFromConversationId

POST /api/fetchConversationsFromConversationId HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 42

{
  "conversationId": "conv_0ae3f12b9c7d41e5"
}

{
  "conversationsList": [
    {
      "id": "507f1f77bcf86cd799439011",
      "conversationId": "conv_0ae3f12b9c7d41e5",
      "role": "assistant",
      "content": "The endpoint /redirect does not validate the `url` parameter, making it susceptible to open-redirect attacks.",
      "lastUpdatedAt": 1745001234
    }
  ],
  "actionErrors": [
    "text"
  ]
}

PreviousScan results NextModify Data

Last updated 2 months ago