Accessing Usage Statistics

To understand your usage of API features you can access usage statistics both in the Meltwater application, and through the API directly.

Note that we have recently introduced a new usage system. Data is available in this new system as of 23rd September 2021. If you would like usage data before this point please request this from support.

Viewing usage in the Meltwater application

Log into the Meltwater application, then navigate to the Meltwater API page (under the Account menu).

On the Meltwater API page you will see a section named Usage Data. Click on View data to continue.

On the Usage Data page you will see multiple charts. You can use the date range selector in the top right to select a time period to view usage for.

The charts on this page include:

  • API Exports - The number of exports you have run
  • API Documents - The number of documents you have exported from the platform
  • API Analytics Breakdown - The API calls you have made to analytics features

You can use the API to fetch more detailed statistics, but these charts should help you understand your usage of the main API features.

Accessing usage statistics using the API

You can fetch statistics for your API usage from the API usage endpoints. The data available from the usage endpoints allows you to keep an eye on your usage limits.

Usage periods

The period parameter is common to all the usage endpoints. This parameter can take one of the following values:

  • 24hours - returns the last 24 hours of usage data, broken down by hour
  • 7days - returns the last 7 days of usage data, broken down by day
  • 30days - returns the last 30 days of usage data, broken down by day
  • 12months - returns the last 12 months of usage data, broken down by month

Exports

Exports per month

If you have access to the export feature, you may be subject to a limit on the number of exports you can run in a month.

You can fetch the number of exports you have run by using the GET usage/me/metrics endpoint, specifying the export_count metric and the exports feature.

For instance to fetch the number of exports you have run in the last 30 days:

curl -X GET \
  --url "https://api.meltwater.com/v3/usage/me/metrics/export_count?feature=exports&period=30days" \
  --header "Accept: application/json" \
  --header "apikey: **********"

An example response is:

{
    "units": "day",
    "count": 56,
    "feature": "exports",
    "metric": "export_count",
    "period": "30days",
    "time_series": [
        {
            "timestamp": "2021-09-21T00:00:00Z",
            "count": 2
        },
        {
            "timestamp": "2021-09-20T00:00:00Z",
            "count": 2
        },
        ...
    ]
}

The returned fields are:

  • feature: the feature requested
  • metric: the metric requested
  • count: the total usage for the requested period (in this case the total number of exports)
  • units: the time unit used for the breakdown of metrics
  • time_series: the breakdown of usage, where count is the usage within each time period (in this case the number of exports)

Documents per month

If you have access to the export feature, you are subject to a limit on the number of documents you can export in a month.

You can fetch the number of documents you have exported by using the GET usage/me/metrics endpoint, specifying the document_count metric and the exports feature.

For instance to fetch the number of documents you have exported in the last 30 days:

curl -X GET \
  --url "https://api.meltwater.com/v3/usage/me/metrics/document_count?feature=exports&period=30days" \
  --header "Accept: application/json" \
  --header "apikey: **********"

An example response is:

{
    "units": "day",
    "count": 19044,
    "feature": "exports",
    "metric": "document_count",
    "period": "30days",
    "time_series": [
        {
            "timestamp": "2021-09-21T00:00:00Z",
            "count": 2438
        },
        {
            "timestamp": "2021-09-20T00:00:00Z",
            "count": 1756
        },
        ...
    ]
}

The fields are the same as explained before, except that the count field in this case reflects the number of documents exported.

Analytics

Daily analytics calls

If you have access to analytics through the API you will be limited to a number of analytics calls per day.

You can fetch the number of analytics requests you have made by using the GET usage/me/requests endpoint. This returns the number of requests you have made to all API endpoints.

For instance to fetch the number of API calls you have made in the last 30 days:

curl -X GET \
  --url "https://api.meltwater.com/v3/usage/me/requests?period=30days" \
  --header "Accept: application/json" \
  --header "apikey: **********"

An example response is:

{
    "units": "day",
    "count": 60,
    "time_series": [
        {
            "timestamp": "2021-09-21T00:00:00Z",
            "calls": {
                "v3": {
                    "analytics": {
                        "summary": {
                            "count": 1
                        },
                        "top-keyphrases": {
                            "count": 1
                        }
                    },
                    ...
                }
            }
        },
        ...
    ]
}

The returned fields are:

  • units: the time unit used for the breakdown of the metrics
  • count: the total usage for the requested period (in this case the total number of all API requests)
  • time_series: the breakdown of API call usage

Within each item of the timeseries the response includes the usage for each API endpoint. So in the example above the analytics summary endpoint was hit once within the report period.

API Calls

As explained on the usage limits page, the API does enforce per minute limits on all API endpoints.

The GET usage/me/requests endpoint returns your API usage for all API endpoints. You can use the same request shown above for analytics calls to look at your usage.