Query community Weekday engagement
curl --request GET \
--url https://apix.us.amity.co/api/v1/analytics/community-metrics/{communityId}/most-active-day \
--header 'Authorization: Bearer <token>'import requests
url = "https://apix.us.amity.co/api/v1/analytics/community-metrics/{communityId}/most-active-day"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://apix.us.amity.co/api/v1/analytics/community-metrics/{communityId}/most-active-day', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://apix.us.amity.co/api/v1/analytics/community-metrics/{communityId}/most-active-day",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://apix.us.amity.co/api/v1/analytics/community-metrics/{communityId}/most-active-day"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://apix.us.amity.co/api/v1/analytics/community-metrics/{communityId}/most-active-day")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://apix.us.amity.co/api/v1/analytics/community-metrics/{communityId}/most-active-day")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"from": "2024-05-01",
"to": "2024-05-07",
"most_active_days": [
{
"weekday": "monday",
"sum_engagements": 30,
"days_count": 2,
"avg_engagements": 15
},
{
"weekday": "tuesday",
"sum_engagements": 10,
"days_count": 1,
"avg_engagements": 10
},
{
"weekday": "wednesday",
"sum_engagements": 0,
"days_count": 0,
"avg_engagements": 0
},
{
"weekday": "thursday",
"sum_engagements": 0,
"days_count": 0,
"avg_engagements": 0
},
{
"weekday": "friday",
"sum_engagements": 0,
"days_count": 0,
"avg_engagements": 0
},
{
"weekday": "saturday",
"sum_engagements": 0,
"days_count": 0,
"avg_engagements": 0
},
{
"weekday": "sunday",
"sum_engagements": 0,
"days_count": 0,
"avg_engagements": 0
}
]
}{
"status": "error",
"code": 400000,
"message": "Bad Request."
}{
"status": "error",
"code": 400300,
"message": "Forbidden error."
}{
"status": "error",
"code": 400400,
"message": "Resource Not Found."
}{
"status": "error",
"code": 500000,
"message": "Parameters validation error!."
}{
"status": "error",
"code": 500000,
"message": "Unexpected error"
}Analytic
Query community Weekday engagement
Aggregates engagements (posts + comments + reactions) per weekday across the date range. Returns all 7 weekdays with sums, counts and average engagements per active day.
GET
/
api
/
v1
/
analytics
/
community-metrics
/
{communityId}
/
most-active-day
Query community Weekday engagement
curl --request GET \
--url https://apix.us.amity.co/api/v1/analytics/community-metrics/{communityId}/most-active-day \
--header 'Authorization: Bearer <token>'import requests
url = "https://apix.us.amity.co/api/v1/analytics/community-metrics/{communityId}/most-active-day"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://apix.us.amity.co/api/v1/analytics/community-metrics/{communityId}/most-active-day', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://apix.us.amity.co/api/v1/analytics/community-metrics/{communityId}/most-active-day",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://apix.us.amity.co/api/v1/analytics/community-metrics/{communityId}/most-active-day"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://apix.us.amity.co/api/v1/analytics/community-metrics/{communityId}/most-active-day")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://apix.us.amity.co/api/v1/analytics/community-metrics/{communityId}/most-active-day")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"from": "2024-05-01",
"to": "2024-05-07",
"most_active_days": [
{
"weekday": "monday",
"sum_engagements": 30,
"days_count": 2,
"avg_engagements": 15
},
{
"weekday": "tuesday",
"sum_engagements": 10,
"days_count": 1,
"avg_engagements": 10
},
{
"weekday": "wednesday",
"sum_engagements": 0,
"days_count": 0,
"avg_engagements": 0
},
{
"weekday": "thursday",
"sum_engagements": 0,
"days_count": 0,
"avg_engagements": 0
},
{
"weekday": "friday",
"sum_engagements": 0,
"days_count": 0,
"avg_engagements": 0
},
{
"weekday": "saturday",
"sum_engagements": 0,
"days_count": 0,
"avg_engagements": 0
},
{
"weekday": "sunday",
"sum_engagements": 0,
"days_count": 0,
"avg_engagements": 0
}
]
}{
"status": "error",
"code": 400000,
"message": "Bad Request."
}{
"status": "error",
"code": 400300,
"message": "Forbidden error."
}{
"status": "error",
"code": 400400,
"message": "Resource Not Found."
}{
"status": "error",
"code": 500000,
"message": "Parameters validation error!."
}{
"status": "error",
"code": 500000,
"message": "Unexpected error"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Community ID
Query Parameters
Inclusive start date (YYYY-MM-DD). Defaults to 7 days before yesterday.
Inclusive end date (YYYY-MM-DD). Defaults to yesterday.
⌘I