Call summary

POST

/api/v1/reporting/calls/summary

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Post,
    RequestUri = new Uri("https://external-api.moja-ai.com/api/v1/reporting/calls/summary"),
    Headers =
    {
        { "X-API-Key", "<X-API-Key>" },
    },
    Content = new StringContent("{ \"group_by\": \"route-to-target\", \"start_date\": \"example\", \"end_date\": \"example\", \"timezone\": \"example\", \"campaign_id\": \"example\", \"publisher_id\": \"example\", \"buyer_id\": \"example\", \"routing_plan_id\": \"example\", \"dial_type_id\": \"example\", \"dialed_target\": \"example\", \"inbound_from\": \"example\", \"inbound_to\": \"example\", \"disposition\": \"example\", \"custom_query\": \"example\", \"qai_only\": false, \"search\": \"example\", \"qai_visible_columns\": [ \"example\" ] }")
    {
        Headers =
        {
            ContentType = new MediaTypeHeaderValue("application/json")
        }
    }
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

package main

import (
  "fmt"
  "strings"
  "net/http"
  "io"
)

func main() {

  url := "https://external-api.moja-ai.com/api/v1/reporting/calls/summary"

  payload := strings.NewReader("{ \"group_by\": \"route-to-target\", \"start_date\": \"example\", \"end_date\": \"example\", \"timezone\": \"example\", \"campaign_id\": \"example\", \"publisher_id\": \"example\", \"buyer_id\": \"example\", \"routing_plan_id\": \"example\", \"dial_type_id\": \"example\", \"dialed_target\": \"example\", \"inbound_from\": \"example\", \"inbound_to\": \"example\", \"disposition\": \"example\", \"custom_query\": \"example\", \"qai_only\": false, \"search\": \"example\", \"qai_visible_columns\": [ \"example\" ] }")

  req, _ := http.NewRequest("POST", url, payload)

  req.Header.Add("X-API-Key", "<X-API-Key>")
  req.Header.Add("Content-Type", "application/json")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

const url = 'https://external-api.moja-ai.com/api/v1/reporting/calls/summary';
const options = {
  method: 'POST',
  headers: {'X-API-Key': '<X-API-Key>', 'Content-Type': 'application/json'},
  body: '{"group_by":"route-to-target","start_date":"example","end_date":"example","timezone":"example","campaign_id":"example","publisher_id":"example","buyer_id":"example","routing_plan_id":"example","dial_type_id":"example","dialed_target":"example","inbound_from":"example","inbound_to":"example","disposition":"example","custom_query":"example","qai_only":false,"search":"example","qai_visible_columns":["example"]}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://external-api.moja-ai.com/api/v1/reporting/calls/summary \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "group_by": "route-to-target", "start_date": "example", "end_date": "example", "timezone": "example", "campaign_id": "example", "publisher_id": "example", "buyer_id": "example", "routing_plan_id": "example", "dial_type_id": "example", "dialed_target": "example", "inbound_from": "example", "inbound_to": "example", "disposition": "example", "custom_query": "example", "qai_only": false, "search": "example", "qai_visible_columns": [ "example" ] }'

Aggregated call metrics grouped by one dimension (campaign, publisher, buyer, routing_plan, caller_id, target_number, publisher_number, ivr_menu, route-to-target, or date, etc.). Admin cost excludes Moja Magic minutes.

Authorizations

MojaApiKeyHeader
MojaApiBearer

Parameters

Header Parameters

X-API-Key

Any of:

string
null

string

Request Body^required

application/json

ReportingCallsSummaryRequest

Aggregated metrics grouped by a single dimension (same options as the in-app summary report).

object

group_by

Group By

Summary dimension: route-to-target, campaign, publisher, buyer, routing_plan, caller_id, target_number, publisher_number, ivr_menu, or date.

string

default: campaign

Allowed values: route-to-target campaign publisher buyer routing_plan caller_id target_number publisher_number ivr_menu date

start_date

required

Start Date

Inclusive range start (ISO 8601).

string

end_date

required

End Date

Inclusive range end (ISO 8601).

string

timezone

Any of:

string
null

string

campaign_id

Any of:

string
null

string

publisher_id

Any of:

string
null

string

buyer_id

Any of:

string
null

string

routing_plan_id

Any of:

string
null

string

dial_type_id

Any of:

string
null

string

dialed_target

Any of:

string
null

string

inbound_from

Any of:

string
null

string

inbound_to

Any of:

string
null

string

disposition

Any of:

string
null

string

custom_query

Any of:

string
null

string

qai_only

Qai Only

If true, only calls with QAI transcript or answers.

boolean

search

Any of:

string
null

string

qai_visible_columns

Any of:

Array<string>
null

Array<string>

Responses

200

Successful Response

application/json

ReportingCallsSummaryResponse

object

data

required

Data

Summary rows with metrics: calls, unique_calls, revenue, payout, profit, billable_minutes (admin: sum of per-call ceil(inbound_duration/60) with Moja Magic minutes excluded except for legacy org ids), cost (admin: sums per-call carrier cost with Moja Magic minutes excluded except for legacy org ids), conversion fields, etc., depending on group_by (same semantics as the in-app reporting summary).

Array<object>

object

key

additional properties

any

Example^generated

{
  "data": [
    {}
  ]
}

400

Bad Request

application/json

ErrorResponse

object

detail

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

Example^generated

{
  "detail": {
    "code": "example",
    "message": "example"
  }
}

401

Unauthorized

application/json

ErrorResponse

object

detail

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

Example^generated

{
  "detail": {
    "code": "example",
    "message": "example"
  }
}

404

Not Found

application/json

ErrorResponse

object

detail

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

Example^generated

{
  "detail": {
    "code": "example",
    "message": "example"
  }
}

409

Conflict

application/json

ErrorResponse

object

detail

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

Example^generated

{
  "detail": {
    "code": "example",
    "message": "example"
  }
}

422

Validation Error

application/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

input

Input

ctx

Context

object

Example^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}

429

Too Many Requests

application/json

ErrorResponse

object

detail

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

Example^generated

{
  "detail": {
    "code": "example",
    "message": "example"
  }
}

Call summary

Authorizations

Parameters

Header Parameters

Request Bodyrequired

Responses

200

Examplegenerated

400

Examplegenerated

401

Examplegenerated

404

Examplegenerated

409

Examplegenerated

422

Examplegenerated

429

Examplegenerated

Request Body^required

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated