Bulk PathPower scores

Parameters:

• entity: person | company (required)
• uuids: comma-separated list of entity UUIDs (max 100)

Returns a score entry for every UUID in the input list. UUIDs with no PathPower data are included with score=null and strength_label=null.

When score is present, strength_label is one of: weak, moderate, strong, very_strong (lowercase, underscore-separated PathPower bands).

GET /v1/pathpower/scores

Bulk lookup PathPower scores for up to 100 entities in one request.

cURL

curl --request GET \
  --url https://production-api.joinrings.com/v1/pathpower/scores \
  --header 'x-api-key: <api-key>'

import requests

url = "https://production-api.joinrings.com/v1/pathpower/scores"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://production-api.joinrings.com/v1/pathpower/scores', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://production-api.joinrings.com/v1/pathpower/scores",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://production-api.joinrings.com/v1/pathpower/scores"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://production-api.joinrings.com/v1/pathpower/scores")
  .header("x-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://production-api.joinrings.com/v1/pathpower/scores")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

{
  "scores": [
    {
      "entity": "<string>",
      "uuid": "<string>",
      "score": 123,
      "score_display": 123,
      "strength_label": "<string>"
    }
  ]
}

Authorizations

x-api-key · string · header · required

Query Parameters

entity · enum<string> · required

Entity type of every UUID in uuids. Required — all UUIDs in a single request must be the same entity type.

Available options: person, company

uuids · string · default: ""

Comma-separated entity UUIDs (max 100). Omitted or empty returns an empty scores list rather than an error.

Response

200 - application/json

Response for bulk PathPower score lookups.

scores · PathPowerScoreItem · object[] · required

Show child attributes