{"openapi":"3.1.0","info":{"title":"Analytics API (v4)","version":"1.0"},"servers":[{"url":"https://api.neuro-id.com/v4"}],"components":{"securitySchemes":{"sec0":{"type":"apiKey","in":"header","x-default":"your_api_key","name":"API-KEY"}}},"security":[{"sec0":[]}],"paths":{"/sites/{site_id}/profiles/{id}/signals":{"get":{"summary":"Signals Endpoint","description":"","operationId":"signals","parameters":[{"name":"id","in":"path","description":"The ID you wish to retreive signals and/or attributes for (likely [set via SET_USER_ID](doc:quickstart#identifying-the-application))","schema":{"type":"string","default":"my-id"},"required":true},{"name":"site_id","in":"path","description":"Required: The ID of your site or form being protected","schema":{"type":"string","default":"form_mysite"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"status\": \"SUCCESS\",\n    \"message\": \"success\",\n    \"moreInfo\": null,\n    \"profile\": {\n        \"id\": \"MY-USER-ID\",\n        \"siteId\": \"form_mySiteID\",\n        \"funnel\": \"funnelNameIfConfigured\",\n        \"clientId\": \"browserID\",\n        \"signals\": [\n          {\n            \"model\": \"fraud_ring_indicator\",\n            \"version\": \"1.0\",\n            \"score\": 1.0,\n            \"label\": null\n          },\n          {\n        \t\t\"model\": \"intent\",\n        \t\t\"version\": \"1.0\",\n           \t\"score\": 98.5213521,\n        \t\t\"label\": \"genuine\"\n      \t\t}\n        ]\n    }\n}\n"},"Not Enough Data":{"value":"{\n  \"status\": \"NOT_ENOUGH_INTERACTION_DATA\",\n  \"message\": \"Data has been received for this profile, though some signals may have insufficient data to calculate a result.\",\n  \"moreInfo\": \"https://neuro-id.readme.io/reference/analytics-api#not_enough_interaction_data\",\n  \"profile\": {\n    \"siteId\": \"form_yourSiteId\",\n    \"funnel\": \"something\",\n    \"clientId\": \"dffffff-3f53-4e2e-aece-clientId\",\n    \"signals\": [\n      {\n        \"model\": \"intent\",\n        \"score\": null,\n        \"version\": \"2.1.2\",\n        \"label\": \"insufficient data\",\n      },\n      {\n        \"model\": \"fraud_ring_indicator\",\n        \"score\": 1.0,\n        \"version\": null,\n        \"label\": null,\n      }\n    ],\n    \"id\": \"some_user_id\"\n  }\n}"}},"schema":{"type":"object","properties":{"status":{"type":"string","example":"SUCCESS"},"message":{"type":"string","example":"success"},"moreInfo":{},"profile":{"type":"object","properties":{"id":{"type":"string","example":"MY-USER-ID"},"siteId":{"type":"string","example":"form_mySiteID"},"funnel":{"type":"string","example":"funnelNameIfConfigured"},"clientId":{"type":"string","example":"browserID"},"signals":{"type":"array","items":{"type":"object","properties":{"model":{"type":"string","example":"fraud_ring_indicator"},"version":{"type":"string","example":"1.0"},"score":{"type":"integer","example":1,"default":0},"label":{}}}}}}}}}}},"401":{"description":"401","content":{"application/json":{"examples":{"Missing API Key":{"value":"{\n\t\"status\": \"MISSING_API_KEY\",\n  \"message\": \"Missing API key\",\n  \"moreInfo\": \"https://neuro-id.readme.io/reference/signals#missing_api_key\"\n}"},"Invalid API Key":{"value":"{\n\t\"status\": \"UNAUTHORIZED_ACCESS\",\n  \"message\": \"Invalid API key\",\n  \"moreInfo\": \"https://neuro-id.readme.io/reference/signals#unauthorized_access\"\n}"}},"schema":{"oneOf":[{"title":"Missing API Key","type":"object","properties":{"status":{"type":"string","example":"MISSING_API_KEY"},"message":{"type":"string","example":"Missing API key"},"moreInfo":{"type":"string","example":"https://neuro-id.readme.io/reference/signals#missing_api_key"}}},{"title":"Invalid API Key","type":"object","properties":{"status":{"type":"string","example":"UNAUTHORIZED_ACCESS"},"message":{"type":"string","example":"Invalid API key"},"moreInfo":{"type":"string","example":"https://neuro-id.readme.io/reference/signals#unauthorized_access"}}}]}}}},"404":{"description":"404","content":{"application/json":{"examples":{"Session Not Found":{"value":"{\n\t\"status\": \"PROFILE_NOT_FOUND\",\n  \"message\": \"No profiles found for the given ID and form\",\n  \"moreInfo\": \"https://neuro-id.readme.io/reference/signals#session_not_found\"\n}"},"Resource Not Found":{"value":"{\n\t\"status\": \"NOT_FOUND\",\n  \"message\": \"Resource not found\",\n  \"moreInfo\": \"https://neuro-id.readme.io/reference/signals#not_found\"\n}"}},"schema":{"oneOf":[{"title":"Session Not Found","type":"object","properties":{"status":{"type":"string","example":"PROFILE_NOT_FOUND"},"message":{"type":"string","example":"No profiles found for the given ID and form"},"moreInfo":{"type":"string","example":"https://neuro-id.readme.io/reference/signals#session_not_found"}}},{"title":"Resource Not Found","type":"object","properties":{"status":{"type":"string","example":"NOT_FOUND"},"message":{"type":"string","example":"Resource not found"},"moreInfo":{"type":"string","example":"https://neuro-id.readme.io/reference/signals#not_found"}}}]}}}}},"deprecated":false}},"/sites/{site_id}/profiles/{id}":{"get":{"summary":"Profiles Endpoint","description":"","operationId":"profiles-endpoint","parameters":[{"name":"id","in":"path","description":"Required: The ID you wish to retreive signals and/or attributes for (likely [set via SET_USER_ID](doc:quickstart#identifying-the-application))","schema":{"type":"string","default":"my-id"},"required":true},{"name":"site_id","in":"path","description":"Required: The ID of your site or form being protected","schema":{"type":"string","default":"form_mysite"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"status\": \"SUCCESS\",\n    \"message\": \"success\",\n    \"moreInfo\": null,\n    \"profile\": {\n        \"id\": \"MY-USER-ID\",\n        \"siteId\": \"form_mySiteID\",\n        \"funnel\": \"funnelNameIfConfigured\",\n        \"clientId\": \"browserID\",\n        \"interactionAttributes\": {                                                                     \n                \"interaction_time_ms\": 3054,                                                                 \n                \"unique_all_targets_count\": 3,                                                               \n                \"client_id_count\": 1,                   \n                \"unique_known_targets_count\": 3,                                                             \n                \"unique_unknown_targets_count\": 0,   \n                \"session_id_count\": 1,                                                                       \n                \"elapsed_time_ms\": 77642,                                                                    \n                \"user_id_count\": 10                                                                          \n            },\n        \"signals\": [\n          {\n            \"model\": \"fraud_ring_indicator\",\n            \"version\": \"1.0\",\n            \"score\": 0.0,\n            \"label\": \"false\",\n            \"attributes\": {}\n          },\n          {\n                \"model\": \"intent\",\n                \"version\": \"1.0\",\n            \t\t\"score\": 98.532351,\n                \"label\": \"genuine\",\n            \"attributes\": {\n              \"pii__timing__feature_1\": 0,\n                \"pii__timing__feature_3\": 4168,\n              \"all_text__method_of_entry__feature_1\": 0,\n              \"pii__method_of_entry__feature_3\": 0,\n              \"pii__interaction_patterns__feature_2\": 0,\n              \"pii__interaction_patterns__feature_1\": 0,\n              \"all_text__method_of_entry__feature_2\": 3,\n              \"pii__method_of_entry__feature_1\": 2,\n              \"pii__interaction_patterns__feature_4\": 0,\n              \"all_text__method_of_entry__feature_3\": 1,\n              \"pii__method_of_entry__feature_2\": 0,\n              \"pii__interaction_patterns__feature_3\": 1.1547005383792517,                                                                                                                                  \n              \"device_type__is_pc\": 0,                                                                                                                                                                     \n              \"pii__interaction_patterns__feature_10\": 1,\n              \"pii__typing_patterns__feature_5\": 0.8031746031746032,\n              \"pii__typing_patterns__feature_4\": null,\n              \"pii__typing_patterns__feature_7\": 128.1138790035587,\n              \"pii__typing_patterns__feature_6\": 0.8031746031746032,\n              \"pii__typing_patterns__feature_9\": 0.7617027101012864,\n              \"pii__typing_patterns__feature_8\": 0.7617027101012864,\n              \"all_text__timing__feature_1\": null,\n              \"all_text__typing_patterns__feature_2\": 0.8031746031746032,\n              \"all_text__timing__feature_4\": 0,\n              \"pii__typing_patterns__feature_1\": null,\n              \"all_text__typing_patterns__feature_1\": null,\n              \"all_text__timing__feature_5\": 0.6225264097604523,\n              \"all_text__timing__feature_2\": 0,\n              \"pii__typing_patterns__feature_3\": 37.634204300520736,\n              \"all_text__timing__feature_3\": 0.33159958707145365,\n              \"pii__typing_patterns__feature_2\": 37.634204300520736,\n              \"pii__transitions__feature_2\": 1,\n              \"pii__transitions__feature_1\": 1\n            }\n            }\n        ]\n    }\n}"}},"schema":{"type":"object","properties":{"status":{"type":"string","example":"SUCCESS"},"message":{"type":"string","example":"success"},"moreInfo":{},"profile":{"type":"object","properties":{"id":{"type":"string","example":"MY-USER-ID"},"siteId":{"type":"string","example":"form_mySiteID"},"funnel":{"type":"string","example":"funnelNameIfConfigured"},"clientId":{"type":"string","example":"browserID"},"interactionAttributes":{"type":"object","properties":{"interaction_time_ms":{"type":"integer","example":3054,"default":0},"unique_all_targets_count":{"type":"integer","example":3,"default":0},"client_id_count":{"type":"integer","example":1,"default":0},"unique_known_targets_count":{"type":"integer","example":3,"default":0},"unique_unknown_targets_count":{"type":"integer","example":0,"default":0},"session_id_count":{"type":"integer","example":1,"default":0},"elapsed_time_ms":{"type":"integer","example":77642,"default":0},"user_id_count":{"type":"integer","example":10,"default":0}}},"signals":{"type":"array","items":{"type":"object","properties":{"model":{"type":"string","example":"fraud_ring_indicator"},"version":{"type":"string","example":"1.0"},"score":{"type":"integer","example":0,"default":0},"label":{"type":"string","example":"false"},"attributes":{"type":"object","properties":{}}}}}}}}}}}}},"deprecated":false}}},"x-readme":{"headers":[],"explorer-enabled":true,"proxy-enabled":true},"x-readme-fauxas":true}