Discover Profile API documentation

This page provides API documentation for Discover Profile

To make a request for Discover Profile result use this POST API.

HTTP Request
POST https://api.hexomatic.com/tool-api/discover-profile?key={YOUR_API_KEY}
Parameters
Fields
YOUR_API_KEY

string

to get YOUR_API_KEY visit hexomatic settings API/Webhook section and copy your key

Request Header
Fields
Content-Type

string

application/json

Example
{
"Content-Type": "application/json"
}
Request Body
Fields
source

string

you should provide email or username

Example
{
"source": "[email protected]",
}
Response Body

if request is successful you will get

JSON representation
{
"taskId": "13f4b463-7e8a-429a-b62b-4afde618a154"
}

if request is not successful you will get

JSON representation
{
"statusCode": 403,
"message": "Forbidden"
}

To get the result for Discover Profile use this GET API.

HTTP Request
GET https://api.hexomatic.com/tool-api/result/{TASK_ID}?key={YOUR_API_KEY}
Parameters
Fields
YOUR_API_KEY

string

to get YOUR_API_KEY visit hexomatic settingsand API/Webhook section and copy your key

TASK_ID

string

if you did Discover Profile POST request you must have received taskId that is valid one month after making the POST request. You can try to make this GET request with apx 1 minute frequency after making the POST request for the tool.

Response Body

if request is successful you will get

JSON representation
{
"result": {
 "_discover_profile": [ 
{
 "_discover_profile_input": ["exampleInput"], 
 "_discover_profile_source": ["Example1"], 
 "_discover_profile_url": ["https://www.example1.com/exampleInput"] 
 "_discover_profile_category": ["Technology"],
},
{
 "_discover_profile_source": ["Example2"], 
 "_discover_profile_url": ["https://www.example2.com/people/exampleInput"] 
 "_discover_profile_category": ["Online Community"],
},
{
 "_discover_profile_source": ["Example3"], 
 "_discover_profile_url": ["https://www.example3.com/User:exampleInput"] 
 "_discover_profile_category": ["Education"], 
}
]
}
}

if request is not successful you will get

JSON representation
{
"statusCode": 403,
"message": "Forbidden"
}