RAMS REST API

This API describes the manner in which the RAmbla Monitoring Service (aka RAMS) can be addressed. For general information about Rambla Web Services and how to access them, first read the RAWS API Basics page, and take a look at the RAWS Documentation pages.

Resources

User Resources

The REST API allows HTTP access to a number of resources for user accounts. Authentication is required, using your user account credentials.

• traffic : total number of hits, volume and advanced user behaviour statistics (time downloaded/streamed, percentage streamed)
• total : user account statistics, including unique users, hits, events and volume totals
• geo : origin of users: top 100 domains, cities and hostnames
• concurrent : number of concurrent users measured at pre-configured intervals (live-streams only)
• storage : the peak storage level being used during a monthly period
• filter : custom filters to monitor a specific part of the traffic
• traffic-type : overview of existing traffic types (= helper resource)

Note that some resources ('geo', 'concurrent') and resource parameters (user behaviour statistics as part of the 'traffic' resource) require their respective statistics layer ('user origin', 'concurrent live users', 'user behaviour') to be turned on first. Otherwise results will be empty. Contact Rambla support for more info.

Responses to these requests will be encoded in one of the available response formats.

Background Info

• RAWS locations : describes how directories, files and file-like objects can be located using RAMS
• RAMS kinds : describes the different kinds of locations, which determine how data is returned by some resources
• RAMS types : describes how some resources order and return their data based on the type of delivery
• RAMS time units and RAMS date range : pre-defined time units which are used by some resources, to determine the period from which data must be returned
• ATOM pagination : describes how some resources split up the requested data into multiple feeds (= pages)

Customer Resources

The REST API also provides direct access to customers for a number of resources. Authentication is required and must be done with the customer credentials.

• users : list user accounts maintained by this customer
• payed : list credit payments made by the customer during a certain period of time
• used : list credits used by the customer or one of its user account during a certain period of time

Methods and URIs

The base URI for RAMS resource access is http://rams.mon01.rambla.be/.

Here is an overview of the operations that are supported on the different types of resources that are accessible by a user account.

URI	GET
/traffic/[{dirname}/.../][{filename}/]	Get the number of hits for a file or directory (recursive).
/total/	Get the unique number of users, hits, events and volume totals for your user account.
/storage/	Get the peak storage level that was used during a monthly period.
/concurrent/v1/	Get the number of concurrent live-streams viewers, measured at pre-configured intervals.
/geo/domain/	Get the top 100 domains for your user accounts.
/geo/city/	Get the top 100 cities for your user accounts.
/geo/host/	Get the top 100 hostnames for your user accounts.
/filter/	Get the existing filters for the user account.
/traffic-type/	Get a list of all traffic types.

Here is an overview of the operations that are supported on the different types of resources that are accessible by a customer.

URI	GET
/customer/users/	Get a list of user accounts maintained by this customer.
/customer/payed/	Get a list of credit payments made by the customer during a certain period of time .
/customer/used/	Get a list of credits used by the customer during a certain period of time.
/customer/used/{username}/	Get a list of credits used by one of the customer's user accounts during a certain period of time.