{"openapi":"3.0.2","paths":{"/results/{projectId}/{sessionId}":{"get":{"description":"Get results for a specific session. Returns at most 100 results, sorted by date in descending order.","summary":"GET check session results","tags":["Detect"],"parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"string"}},{"name":"sessionId","in":"path","required":true,"schema":{"type":"string"}}],"operationId":"getSessionResults","responses":{"200":{"description":"200","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"scoreBot":{"type":"number","minimum":0,"maximum":1},"scoreProxyVpn":{"type":"number","minimum":0,"maximum":1},"ipAddress":{"type":"string"},"createdAt":{"type":"string","format":"date-time"}},"required":["scoreBot","scoreProxyVpn","ipAddress","createdAt"]},"nullable":true}}}}}},"401":{"description":"401","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"500":{"description":"500","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}}},"security":[{"bearerAuth":[]}]}},"/results/{projectId}/{sessionId}/general":{"get":{"description":"Get the overall result for a specific session by analysing all entries. Keep in mind that this is an overall score of the entire session and not the state of the last result (user's current state). If you only care if the user was detected being a bot, using proxies or VPNs during the session, this is the endpoint to use","summary":"GET check session overall result","tags":["Detect"],"parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"string"}},{"name":"sessionId","in":"path","required":true,"schema":{"type":"string"}}],"operationId":"getSessionGeneral","responses":{"200":{"description":"200","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"scoreBot":{"type":"number","minimum":0,"maximum":1},"scoreProxyVpn":{"type":"number","minimum":0,"maximum":1}},"required":["scoreBot","scoreProxyVpn"],"nullable":true}}}}}},"401":{"description":"401","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"500":{"description":"500","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}}},"security":[{"bearerAuth":[]}]}},"/plan":{"get":{"description":"Get the current plan details for the user authenticated via the api key","summary":"GET current plan details","tags":["Plans"],"parameters":[],"operationId":"getPlan","responses":{"200":{"description":"200","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"maxRps":{"type":"number","minimum":0,"maximum":1000},"maxProjects":{"type":"number","minimum":0,"maximum":1000},"maxRequests":{"type":"number","minimum":0,"maximum":200000000},"expiresAt":{"type":"string","format":"date-time"},"subscribedAt":{"type":"string","format":"date-time"},"unsubscribedAt":{"type":"string","format":"date-time","nullable":true},"status":{"type":"string","enum":["trialing","active","canceled","past_due","paused"]}},"required":["id","name","description","maxRps","maxProjects","maxRequests","expiresAt","subscribedAt","status"],"nullable":true}}}}}},"401":{"description":"401","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"500":{"description":"500","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}}},"security":[{"bearerAuth":[]}]}},"/projects/{projectId}":{"get":{"description":"Get the details of a given project","summary":"GET a project","tags":["Projects"],"parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"string"}}],"operationId":"getProject","responses":{"200":{"description":"200","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"apiKeyPublic":{"type":"string"},"apiKeyPrivate":{"type":"string"},"domain":{"type":"string"},"disabled":{"type":"boolean"},"createdAt":{"type":"string","format":"date-time"}},"required":["id","name","apiKeyPublic","apiKeyPrivate","domain","disabled","createdAt"],"nullable":true}}}}}},"401":{"description":"401","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"500":{"description":"500","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}}},"security":[{"bearerAuth":[]}]}},"/projects/{projectId}/webhooks":{"post":{"description":"Creates a new webhook for the specified project","summary":"POST create project webhook","tags":["Webhooks"],"parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"string"}}],"operationId":"createWebhook","requestBody":{"description":"Body","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["proxy_vpn_detect"]},"url":{"type":"string","format":"uri"}},"required":["type","url"]}}}},"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"nullable":true}}}}}},"401":{"description":"401","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"500":{"description":"500","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}}},"security":[{"bearerAuth":[]}]}},"/projects/{projectId}/webhooks/{webhookId}":{"delete":{"description":"Deletes a webhook from the specified project","summary":"DELETE delete project webhook","tags":["Webhooks"],"parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"string"}},{"name":"webhookId","in":"path","required":true,"schema":{"type":"string"}}],"operationId":"deleteWebhook","responses":{"200":{"description":"200","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"nullable":true}}}}}},"401":{"description":"401","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"500":{"description":"500","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}}},"security":[{"bearerAuth":[]}]}}},"info":{"title":"VisitorQuery API","version":"1.0.0"},"servers":[{"url":"https://visitorquery.com/api/v1"}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"The developer API key from your account"}}},"tags":[{"name":"Projects","description":"Projects"},{"name":"Checks","description":"Retrieve check results"},{"name":"Plans","description":"Current plan details"}]}