AgentPostProcessing
AgentPrompts
AgentTools
Agents
Analytics
AudienceFeeds
Auth
Profile
AuthenticatedSession
Automations
Billing
CallOutcomeClassifiers
Calls
Companies
Contacts
ConversionPixel
Countries
CryptoTransactions
CustomFields
DataFiles
DomainAccounts
DomainPlanRules
DomainPlans
DomainProxies
Domains
EmailCampaignTemplates
EmailVerificationNotification
EnrichmentMnp
HlrValidations
Integrations
LivePhoneSms
LivePhoneStatusLogs
LivePhoneWebhook
LivePhones
MobileNetworks
NetworkBrands
NewPassword
Number
Offers
PasswordResetLink
PaypalTransactions
PlatformDomainPlans
PlatformNotifications
RateParser
RegisteredUser
Segments
SellerEndpoints
SellerProfitLogic
SellerProfitLogicRules
SellerReports
Slack
SmsCampaignOffers
SmsCampaignSenderids
SmsCampaignTexts
SmsCampaigns
- GET
  Get v1smscampaigns
- PUT
  Put v1smscampaigns
- DEL
  Delete v1smscampaigns
- GET
  Get v1smscampaigns 1
- POST
  Post v1smscampaigns
- GET
  Get v1smscampaigns logs
- POST
  sms.campaigns.reports
- POST
  Post v1smscampaigns send
- POST
  Post v1smscampaigns is ready
- POST
  Post v1smscampaigns plannerstop
- POST
  Post v1smscampaigns stop
- GET
  Get v1smscampaigns domains cost
SmsRoutingBlacklist
SmsRoutingPlanRules
SmsRoutingPlans
SmsRoutingRates
SmsRoutingRoutes
SmsRoutingSmppConnections
SmsRoutingTest
SmsTests
SmsTextsGenerate
Socialite
StaticClientRates
TeamInvitations
TeamInvoices
TeamTokens
UserTeams
VerifyEmail
VoiceAccounts
VoiceCampaigns
WireTransfers

sms.campaigns.reports

curl --request POST \
  --url https://api.comm.com/api/v1/sms/campaigns/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"
    }
  ],
  "groupKeys": "[\"campaign_uuid\"]\nNot the column type, it'\''s a filter of the query",
  "selectCols": [
    "<any>"
  ],
  "startRow": 1,
  "endRow": 2,
  "groupByAll": true
}'

{
  "data": "<string>",
  "meta": {
    "current_page": "<string>",
    "last_page": "<string>",
    "per_page": "<string>",
    "total": "<string>"
  }
}

SmsCampaigns

sms.campaigns.reports

Examples:

Getting clicks, sent count per campaign request:

{
"rowGroupCols": [
{
"field": "campaign_id"
}
]
}

response:

{
"data": [
{
...
"campaign_id": "2bdb6f47-ac08-34b8-9c89-6497b3be237f",
"is_sent": "4",
"is_clicked": "0",
...
},
"meta": { ... }
}

Getting clicks, sent count per country request:

{
"rowGroupCols": [
{
"field": "country_id"
}
]
}

response:

{
"data": [
{
...
"country_id": 226,
"is_sent": "4",
"is_clicked": "0",
...
},
"meta": { ... }
}

Group per hour/date/year-week, year-month

Use show_as to specify the group type DateTime columns can be group by hour, date, year-week, year-month

example:

{
"rowGroupCols": [
{
"field": "sent_at",
"show_as": "date"
}
]
}

response:

{
"data": [
{
...
"sent_at": "2023-08-03",
"is_sent": "230",
"is_clicked": "25",
"is_lead": "0",
"is_sale": "0",
"ctr": 10.87,
...
},

Group by multiple columns

Use groupByAll to group by all columns that are in rowGroupCols

example:

{
"rowGroupCols": [
{
"field": "sent_at",
"show_as": "date"
},
{
"field": "country_id"
}
],
"groupByAll": true
}

response:

{
"data": [
{
...
"sent_at": "2023-08-03",
"country_id": 226,
"is_sent": "210",
"is_clicked": "25",
"is_lead": "0",
"is_sale": "0",
"ctr": 11.9,
...
"sent_at": "2023-08-03",
"country_id": 13,
"is_sent": "20",
"is_clicked": "0",
"is_lead": "0",
"is_sale": "0",
"ctr": 0,
...
},

without groupByAll parameter the response will be grouped by the first column in rowGroupCols. . usually this response is used for the AG-grid component:

| sent_at ______ | country_id | is_sent | is_clicked | ctr __ |
| -------------- | ---------- | ------- | ---------- | ------ |
| [+] 2023-08-03 | 2 ________ | 230 ___ | 25 _______ | 11.9 _ |

after this the user can expand the row and see the data for each country:

| sent_at ______ | country_id __ | is_sent | is_clicked | ctr_ |
--------------------------------------------------------------- |
| [-] 2023-08-03 | 2 ___________ | 230 ___ | 25 _______ | 11.9 |
--------------------------------------------------------------- |
| ______________ | 226 _________ | 210 ___ | 25 _______ | 11.9 |
--------------------------------------------------------------- |
| ______________ | 13 __________ | 20 ____ | 0 ________ | 0 __ |

POST

sms

campaigns

reports

sms.campaigns.reports

curl --request POST \
  --url https://api.comm.com/api/v1/sms/campaigns/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"
    }
  ],
  "groupKeys": "[\"campaign_uuid\"]\nNot the column type, it'\''s a filter of the query",
  "selectCols": [
    "<any>"
  ],
  "startRow": 1,
  "endRow": 2,
  "groupByAll": true
}'

{
  "data": "<string>",
  "meta": {
    "current_page": "<string>",
    "last_page": "<string>",
    "per_page": "<string>",
    "total": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.