Get dashboard metrics
curl --request GET \
--url https://api.yalg.ai/v1/statistics/dashboard \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.yalg.ai/v1/statistics/dashboard', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.yalg.ai/v1/statistics/dashboard"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"totalPosts": {
"value": 24,
"change": {
"value": 12,
"type": "increase"
},
"description": "from last month"
},
"engagementRate": {
"value": "3.2%",
"change": {
"value": 8,
"type": "increase"
},
"description": "vs last month"
},
"avgComments": {
"value": 8.5,
"change": {
"value": 15,
"type": "increase"
},
"description": "per post"
},
"impressions": {
"value": "12.4K",
"change": {
"value": 22,
"type": "increase"
},
"description": "this month"
}
}{
"statusCode": 400,
"message": "Validation failed",
"error": "Bad Request",
"code": "validation_failed"
}{
"statusCode": 401,
"message": "Invalid or missing API key",
"error": "Unauthorized",
"code": "unauthorized"
}{
"statusCode": 403,
"message": "Access denied",
"error": "Forbidden",
"code": "forbidden"
}{
"statusCode": 429,
"message": "Rate limit exceeded",
"error": "Too Many Requests",
"code": "rate_limit_exceeded",
"retryAfter": 60
}{
"statusCode": 500,
"message": "Internal server error",
"error": "Internal Server Error",
"code": "internal_server_error"
}statistics
Get dashboard metrics
Retrieves key performance metrics for the dashboard including posts, engagement, comments, and impressions with month-over-month comparisons
GET
/
v1
/
statistics
/
dashboard
Get dashboard metrics
curl --request GET \
--url https://api.yalg.ai/v1/statistics/dashboard \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.yalg.ai/v1/statistics/dashboard', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.yalg.ai/v1/statistics/dashboard"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"totalPosts": {
"value": 24,
"change": {
"value": 12,
"type": "increase"
},
"description": "from last month"
},
"engagementRate": {
"value": "3.2%",
"change": {
"value": 8,
"type": "increase"
},
"description": "vs last month"
},
"avgComments": {
"value": 8.5,
"change": {
"value": 15,
"type": "increase"
},
"description": "per post"
},
"impressions": {
"value": "12.4K",
"change": {
"value": 22,
"type": "increase"
},
"description": "this month"
}
}{
"statusCode": 400,
"message": "Validation failed",
"error": "Bad Request",
"code": "validation_failed"
}{
"statusCode": 401,
"message": "Invalid or missing API key",
"error": "Unauthorized",
"code": "unauthorized"
}{
"statusCode": 403,
"message": "Access denied",
"error": "Forbidden",
"code": "forbidden"
}{
"statusCode": 429,
"message": "Rate limit exceeded",
"error": "Too Many Requests",
"code": "rate_limit_exceeded",
"retryAfter": 60
}{
"statusCode": 500,
"message": "Internal server error",
"error": "Internal Server Error",
"code": "internal_server_error"
}Authorizations
ApiKeyAuthbearer
YALG Developer API key. Send it in the x-api-key header from a server-side environment only.
Response
Dashboard metrics retrieved successfully
⌘I