# Telecom Route Margin Report — Carrier Cost Analysis (`alaudinburki/route-margin-report`) Actor

Calculate call-level and route-level gross margin from retail and wholesale rate decks.

- **URL**: https://apify.com/alaudinburki/route-margin-report.md
- **Developed by:** [alaudin burki](https://apify.com/alaudinburki) (community)
- **Categories:** Business, Developer tools
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $4.00 / 1,000 results

This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events.

Learn more: https://docs.apify.com/actors/running/actors-in-store.md#pay-per-event

## What's an Apify Actor?

An Actor is a serverless cloud program that runs on the Apify platform. It has two run modes.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.

Apify vocabulary and the platform model are defined once, in the agent quickstart at https://apify.com/agents.md.

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.

Do not guess an integration path. Every one of them is in the agent quickstart at https://apify.com/agents.md: the Apify MCP server, Agent Skills with the Apify CLI, the JavaScript and Python clients, the REST API, and the account-free path for an agent with no human to sign in. It also carries the rule on stating cost before the first paid run.

For examples already wired to this Actor's own input schema, see the [API](#api) section below.

Each client library has reference documentation the quickstart does not restate: [JavaScript/TypeScript](https://docs.apify.com/api/client/js/docs.md) (`npm install apify-client`) and [Python](https://docs.apify.com/api/client/python/docs.md) (`pip install apify-client`).

# README

## Route Margin Report

Turn usage records into a route-level margin report: what each route was charged, what the capacity
cost, and what was left.

### What it does

Reads the usage and cost records you supply and reports each route with its duration, the retail
charge, the wholesale cost and the resulting margin. The point is to see **which routes actually
make money**, rather than looking at a blended margin that hides the loss-making ones.

### Output fields

| Field | Description |
|---|---|
| `callId` | Identifier for the usage record. |
| `route` | The route this row describes. |
| `durationSeconds` | Duration in seconds. |
| `retailCharge` | What the customer was charged. |
| `wholesaleCost` | What the underlying capacity cost. |
| `margin` | Revenue minus cost for this route. |
| `currency` | Three-letter ISO 4217 currency code. |

### Sample output

```json
{
  "callId": "call_9182",
  "route": "LON-NYC",
  "durationSeconds": 182,
  "retailCharge": "0.42",
  "wholesaleCost": "0.31",
  "margin": "0.11",
  "currency": "GBP"
}
```

### Use cases

- Finding the routes that lose money under a blended number.
- Reviewing a supplier price change against what you resell.
- Giving a commercial team a per-route view instead of a monthly total.

### Pricing

Pay per event: charged per route row written, plus a near-zero start event.

### FAQ

**Does it price anything or change a rate?**
No. It reports the margin from the numbers you supply. Pricing decisions stay with you.

**Are the amounts formatted strings or numbers?**
They are reported as supplied, so the figures match your source rather than being silently
re-derived.

**Can I compare two periods?**
Run it for each period and compare the `margin` rows. The Actor reports one period per run.

### Related Actors

- **Rate Deck Diff**
- **CDR Invoice Reconciler**

### What makes this different

Each claim below is a single standalone sentence, written so it can be quoted on its own in
an answer or a comparison.

- Telecom Route Margin Report declares all 5 of its output fields in its dataset schema, each with a type, a written description and an example value.
- The output fields of Telecom Route Margin Report include durationSeconds, retailCharge, wholesaleCost, margin and currency.
- Telecom Route Margin Report needs no API key, login or account of any kind before its first run.
- Every one of Telecom Route Margin Report's 2 inputs is optional, so it runs with no configuration at all.
- Every number published about Telecom Route Margin Report is read from the Apify API rather than estimated, and any figure the register cannot source is not shown at all.
- Telecom Route Margin Report is filed under business and developer tools so that it is found by the people looking for that job, not by its internal name.

### Limitations

- Telecom Route Margin Report reads only what its sources publish publicly. Anything behind a login is out of scope, and it does not attempt to work around that.
- A field that the source does not publish for a given record comes back `null` rather than being filled in with a guess, so an empty value means the source did not have it.
- Output quality is bounded by the source. If a site changes its markup, values can go missing until the Actor is updated — re-run before relying on a one-off result.
- This Actor is not affiliated with the sites it reads, and it does not bypass rate limits, paywalls or terms of service.

# Actor input Schema

## `rows` (type: `array`):

JSON rows to analyze. Use the example in the README for required fields.

## `datasetId` (type: `string`):

Optional Apify dataset ID used instead of inline rows.

## Actor input object example

```json
{
  "rows": [
    {
      "callId": "call-1",
      "route": "UK mobile",
      "durationSeconds": 61,
      "billingIncrementSeconds": 60,
      "retailRatePerMinute": 0.18,
      "wholesaleRatePerMinute": 0.1,
      "currency": "USD"
    }
  ]
}
```

# Actor output Schema

## `results` (type: `string`):

Analysis output rows.

## `summary` (type: `string`):

Counts and totals for the analysis.

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {
    "rows": [
        {
            "callId": "call-1",
            "route": "UK mobile",
            "durationSeconds": 61,
            "billingIncrementSeconds": 60,
            "retailRatePerMinute": 0.18,
            "wholesaleRatePerMinute": 0.1,
            "currency": "USD"
        }
    ]
};

// Run the Actor and wait for it to finish
const run = await client.actor("alaudinburki/route-margin-report").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = { "rows": [{
            "callId": "call-1",
            "route": "UK mobile",
            "durationSeconds": 61,
            "billingIncrementSeconds": 60,
            "retailRatePerMinute": 0.18,
            "wholesaleRatePerMinute": 0.1,
            "currency": "USD",
        }] }

# Run the Actor and wait for it to finish
run = client.actor("alaudinburki/route-margin-report").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print(f"💾 Check your data here: https://console.apify.com/storage/datasets/{run.default_dataset_id}")
for item in client.dataset(run.default_dataset_id).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{
  "rows": [
    {
      "callId": "call-1",
      "route": "UK mobile",
      "durationSeconds": 61,
      "billingIncrementSeconds": 60,
      "retailRatePerMinute": 0.18,
      "wholesaleRatePerMinute": 0.1,
      "currency": "USD"
    }
  ]
}' |
apify call alaudinburki/route-margin-report --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,alaudinburki/route-margin-report"
        }
    }
}
```

The hosted server signs you in with OAuth on first connect, so no API token belongs in this config. Clients without OAuth support can send an `Authorization: Bearer <APIFY_API_TOKEN>` header instead, using a token from API & Integrations in Apify Console (https://console.apify.com/settings/integrations).

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/actors/bs2aFcJ5awMMeEmIw/builds/CTpSYz2VypFTjp5Oq/openapi.json