Skip to main content

Standard Interface

retrieveSSI

This method allows you to retrieve your current SSI (Social Selling Index).


try {
  const workflowId = await linkedapi.retrieveSSI.execute();
  
  const { data } = await linkedapi.retrieveSSI.result(workflowId);
  
  // The structure of the 'data' object is below
  if (data) {
    console.log('Your SSI score:', data.ssi);
    console.log('Industry ranking:', data.industryTop + '%');
    console.log('Network ranking:', data.networkTop + '%');
  }
} catch (e) {
  // A list of all critical errors can be found here:
  // https://linkedapi.io/sdks/handling-results-and-errors/#handling-critical-errors
  if (e instanceof LinkedApiError) {
    console.error(`Critical Error - Type: ${e.type}, Message: ${e.message}`);
  } else {
    console.error('An unexpected, non-API error occurred:', e);
  }
}


# Python SDK is coming soon!
#
# You can always use Linked API through HTTP
# https://linkedapi.io/docs/


// Go SDK is coming soon!
//
// You can always use Linked API through HTTP
// https://linkedapi.io/docs/

Params

The method doesn't require any parameters.

Data

  • ssi – number (1-100) representing your current Social Selling Index.
  • industryTop – percentage (1-100) showing your industry ranking by SSI score. For example, a value of 5 means you are in the top 5% of your industry.
  • networkTop – percentage (1-100) showing your network ranking by SSI score. For example, a value of 10 means you are in the top 10% of your network.

Errors

The method has no execution errors (errors is always []).