Download Contact Sales
HTTP API

Your MCS results, in the tools your teams already use.

MyConnection Server 12 adds a secure, read-only HTTP API. Pull VoIP, bandwidth, capacity and route results as JSON into your dashboards, reports, customer portals and data warehouse.

Why It Matters

Results nobody sees don't change anything.

MCS builds a detailed, continuous record of how every connection performs. Until now, seeing that record meant opening MCS. The people who act on it, from the NOC to the account manager to the budget holder, spend their day somewhere else.

The HTTP API sends MCS results to the places those people already look. Anything that can make an HTTPS request and read JSON can use it: dashboard and BI platforms, service desk tools, customer portals, data warehouses, or a short script.

In the example, the London average looks healthy. The chart shows the half hour when it wasn't, and that is the half hour your users remember.

Network quality: all sites Source: MCS HTTP API
Average MOS4.14
Average jitter8.4ms
Packet loss0.39%
Tests run5,760
Jitter, London branch to SIP provider Last 24 hours
0 10 20 30 40 ms 00:00 06:00 12:00 18:00 24:00 Alert threshold 30 ms 14:15, 38 ms
SiteMOSJitterLossStatus
London branch4.314.7 ms0.02%Good
Manchester4.362.9 ms0.00%Good
Dublin3.7118.6 ms1.20%Warning
Home workers4.187.4 ms0.35%Good
Illustrative example: MCS results in a third-party dashboard.
Where It Goes

Put the evidence in front of the people who act on it

The same results you see in MCS reports, delivered wherever decisions actually get made.

The NOC wall

Show MCS quality results on the same screens as your infrastructure monitoring, so a jitter spike lines up with the change, the backup job or the provider fault that caused it. Attach the actual test results to the service desk ticket, not a description of them.

The customer portal

Carriers, MSPs and UC providers can show each customer the quality of their own service, or fill in the monthly SLA report automatically. A key only returns what its owning user can see, so if each customer has its own MCS account, each customer's key returns only their data.

The data warehouse

Keep years of results next to the business data they explain, in the warehouse and BI tools your analysts already use. Summarise by time period on the way out, and page through long histories in manageable batches.

How It Works

One key. One request. Your data.

No SDK or special client to install. If a tool can call a URL, it can read MCS results.

1

Switch it on, issue a key

The API is off until an administrator enables it. Create a key for each tool or person that needs data, restrict it to known addresses, and set it to expire if the need is temporary.

2

Ask for the data

One HTTPS request, using the same selections as MCS reports: test type, time window, source address and other report filters, as individual tests or summaries by time period.

3

Use it anywhere

Results come back as JSON, with paging for large pulls. Load them into a dashboard, a report, a portal or a database, on whatever schedule suits you.

Request
# The last 24 hours of VoIP results from one address
curl -G "https://yourserver.example.com/myspeed/api/v1/data" \
     -H "Authorization: Bearer mcs_ab12cd34ef56_..." \
     -H "User-Agent: Mozilla/5.0" \
     -d plugins=voip \
     -d last=1 -d lastunits=days \
     --data-urlencode "adv=[gbl:ip=1.2.3.4]"

Filters use the same syntax as MCS reports. Large result sets are paged with offset and limit.

Response
{
  "meta": {
    "count": 1440,
    "returned": 500,
    "offset": 0,
    "limit": 500,
    "truncated": true
  },
  "data": [ ... ]
}

Each record in data carries the same fields you see in the MCS tabular report.

Security

Read-only by design. Off until you switch it on.

The API was built for organisations where the security team has the final say. It adds no new way to change anything in MCS, and nothing is reachable until an administrator decides it should be.

It follows the same principles as the rest of the platform. See how MCS is secured.

  • Off by default. The API does nothing until it is enabled, and it can be switched off again at any time.
  • Read-only. Keys retrieve results. They cannot change configuration, start tests or delete data.
  • Scoped to a user. Every key belongs to one MCS user and returns only what that user is permitted to see.
  • Secrets stored hashed. The full key is shown once, when it is created, and cannot be retrieved afterwards.
  • Restricted and time-limited. Limit each key to known IP addresses or ranges, cap its request rate, and set it to expire automatically.
  • HTTPS required. Plain HTTP requests are rejected by default, and a revoked key stops working immediately.
  • Separate privilege. Creating and revoking keys requires API administration rights, which you grant to specific administrators.
Tests In, Results Out

Your systems can start the testing too

The HTTP API gets results out of MCS. Two other interfaces let your own systems put testing in motion.

Get Started

See your results in your own tools

Book a demo and we'll walk through the HTTP API against a live MCS server, or go straight to the documentation.