curl -X GET 'https://api.weir.ai/platforms/platform_123456789' \
-H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
-H 'x-source: console'
{
"data": {
"platformId": "platform_123456789",
"name": "My Platform",
"type": "Forum/Community",
"domain": "myplatform.com",
"description": "A community platform",
"teamId": "team_123456789",
"teamName": "Development Team",
"status": "verified",
"verificationMethod": "dns",
"verifiedAt": "2024-01-20T10:00:00Z",
"settings": {
"crawlingEnabled": true,
"detectionFrequency": "daily"
},
"statistics": {
"contentScanned": 15000,
"nilDetections": 45,
"lastScanAt": "2024-01-22T14:00:00Z"
},
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2024-01-22T15:30:00Z"
},
"message": "Platform details retrieved successfully",
"status": "success"
}
Console APIs - Platforms
Get Platform Details
Retrieve detailed information about a specific platform
GET
/
platforms
/
:platformId
curl -X GET 'https://api.weir.ai/platforms/platform_123456789' \
-H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
-H 'x-source: console'
{
"data": {
"platformId": "platform_123456789",
"name": "My Platform",
"type": "Forum/Community",
"domain": "myplatform.com",
"description": "A community platform",
"teamId": "team_123456789",
"teamName": "Development Team",
"status": "verified",
"verificationMethod": "dns",
"verifiedAt": "2024-01-20T10:00:00Z",
"settings": {
"crawlingEnabled": true,
"detectionFrequency": "daily"
},
"statistics": {
"contentScanned": 15000,
"nilDetections": 45,
"lastScanAt": "2024-01-22T14:00:00Z"
},
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2024-01-22T15:30:00Z"
},
"message": "Platform details retrieved successfully",
"status": "success"
}
Get Platform Details
Retrieve comprehensive details about a specific platform.curl -X GET 'https://api.weir.ai/platforms/platform_123456789' \
-H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
-H 'x-source: console'
{
"data": {
"platformId": "platform_123456789",
"name": "My Platform",
"type": "Forum/Community",
"domain": "myplatform.com",
"description": "A community platform",
"teamId": "team_123456789",
"teamName": "Development Team",
"status": "verified",
"verificationMethod": "dns",
"verifiedAt": "2024-01-20T10:00:00Z",
"settings": {
"crawlingEnabled": true,
"detectionFrequency": "daily"
},
"statistics": {
"contentScanned": 15000,
"nilDetections": 45,
"lastScanAt": "2024-01-22T14:00:00Z"
},
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2024-01-22T15:30:00Z"
},
"message": "Platform details retrieved successfully",
"status": "success"
}
Path Parameters
Unique identifier of the platform.
Response Fields
Platform details object.
Show Platform Properties
Show Platform Properties
Unique platform identifier.
Platform name.
Platform type.
Platform domain.
Platform status (verified, pending_verification, failed).
Platform configuration settings.
Platform usage statistics.
Usage Examples
const getPlatformDetails = async (platformId, accessToken) => {
const response = await fetch(`https://api.weir.ai/platforms/${platformId}`, {
headers: {
'Authorization': `Bearer ${accessToken}`,
'x-source': 'console'
}
});
if (!response.ok) throw new Error(`HTTP error! status: ${response.status}`);
return await response.json();
};
Pro Tip: Use this endpoint to get comprehensive platform information including verification status and statistics.
Was this page helpful?
⌘I