curl --request POST \
--url https://api.comm.com/api/v1/hub/reports \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"sortModel": [
{
"sort": "asc",
"colId": "updated_datetime"
}
],
"filterModel": "{\"is_sent\":{\"filterType\":\"number\",\"type\":\"greaterThan\",\"filter\":5}}\n\nnote that it needs to be col_id: {FilterModel}, PHP doesn'\''t support this kind of description.",
"rowGroupCols": [
{
"id": "campaign_id",
"displayName": "Campaign_Id",
"field": "campaign_id"
}
],
"selectCols": "[\"country_id\"]\nWill make a select query with only the columns in the array, if not provided default columns will be selected",
"groupKeys": "[\"campaign_uuid\"]\nNot the column type, it'\''s a filter of the query",
"startRow": 1,
"endRow": 2,
"groupByAll": true
}'
{
"data": [
{
"sms_id": "<string>",
"endpoint_id": "<string>",
"sms_route_id": "<string>",
"sms_routing_plan_id": "<string>",
"client_company_id": "<string>",
"vendor_company_id": "<string>",
"foreign_id": "<string>",
"country_id": "<string>",
"source_addr": "<string>",
"destination_addr": "<string>",
"message_payload": "<string>",
"dlr_status": "<string>",
"network_id": "<string>",
"network_brand": "<string>",
"cost": "<string>",
"profit": "<string>",
"is_sent": "<string>",
"is_clicked": "<string>",
"is_lead": "<string>",
"is_sale": "<string>",
"is_delivered": "<string>",
"created_at": "<string>"
}
],
"meta": {
"total": 123
}
}
curl --request POST \
--url https://api.comm.com/api/v1/hub/reports \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"sortModel": [
{
"sort": "asc",
"colId": "updated_datetime"
}
],
"filterModel": "{\"is_sent\":{\"filterType\":\"number\",\"type\":\"greaterThan\",\"filter\":5}}\n\nnote that it needs to be col_id: {FilterModel}, PHP doesn'\''t support this kind of description.",
"rowGroupCols": [
{
"id": "campaign_id",
"displayName": "Campaign_Id",
"field": "campaign_id"
}
],
"selectCols": "[\"country_id\"]\nWill make a select query with only the columns in the array, if not provided default columns will be selected",
"groupKeys": "[\"campaign_uuid\"]\nNot the column type, it'\''s a filter of the query",
"startRow": 1,
"endRow": 2,
"groupByAll": true
}'
{
"data": [
{
"sms_id": "<string>",
"endpoint_id": "<string>",
"sms_route_id": "<string>",
"sms_routing_plan_id": "<string>",
"client_company_id": "<string>",
"vendor_company_id": "<string>",
"foreign_id": "<string>",
"country_id": "<string>",
"source_addr": "<string>",
"destination_addr": "<string>",
"message_payload": "<string>",
"dlr_status": "<string>",
"network_id": "<string>",
"network_brand": "<string>",
"cost": "<string>",
"profit": "<string>",
"is_sent": "<string>",
"is_clicked": "<string>",
"is_lead": "<string>",
"is_sale": "<string>",
"is_delivered": "<string>",
"created_at": "<string>"
}
],
"meta": {
"total": 123
}
}
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
The response is of type object
.