Checking API usage statistics

This page explains how to check Linked API usage statistics. You can use this information to stay within LinkedIn limits for your account.

In addition to monitoring usage, you can configure action limits for each account on the platform. When a limit is reached, actions will automatically return a limitExceeded error instead of executing.

We provide statistics as an array of all actions executed during a specific period. To access it, make a GET request to the following endpoint with 2 parameters:

GET https://api.linkedapi.io/stats/actions?start={}&end={}

// Get usage stats for the last 7 days
const endDate = new Date();
const startDate = new Date(endDate.getTime() - 7 * 24 * 60 * 60 * 1000);

const { data } = await linkedapi.getApiUsage({
  start: startDate.toISOString(),
  end: endDate.toISOString()
});

from datetime import datetime, timedelta, timezone
from linkedapi import ApiUsageParams

# Get usage stats for the last 7 days
end_date = datetime.now(timezone.utc)
start_date = end_date - timedelta(days=7)

result = linkedapi.get_api_usage(
    ApiUsageParams(
        start=start_date.isoformat(),
        end=end_date.isoformat(),
    )
)

Parameters

In the CLI this is linkedin stats usage:

bash

linkedin stats usage --start <timestamp> --end <timestamp> [flags]

Flag	Type	Required	Description
`--start`	string	yes	Start date in ISO timestamp
`--end`	string	yes	End date in ISO timestamp

start – timestamp from which the statistics will be retrieved.
end – timestamp up to which the statistics will be retrieved.

The difference between start and end must not exceed 30 days.

Result

In response, you receive an array of actions executed during the specified period:

json

{
  "success": true,
  "result": [
    {
      "actionType": "st.openCompanyPage",
      "success": true,
      "time": "2023-01-02T12:30:00Z"
    },
    {
      "actionType": "st.sendMessage",
      "success": false,
      "time": "2023-01-03T12:30:00Z"
    },
    {
      "actionType": "nv.retrieveCompanyEmployees",
      "success": true,
      "time": "2023-01-04T12:30:00Z"
    },
    {
      "actionType": "st.sendConnectionRequest",
      "success": true,
      "time": "2023-01-07T12:30:00Z"
    }
    ...
  ]
}

In case of an unsuccessful request, you'll receive one of the common errors.

PreviousRetrieving SSI, Performance Nextst.sendMessage