Partner Portal

Get partner metrics

Get the Salesforce scorecard for the authenticated partner organization: active certifications, eligible billings, new logos won and deal registration activity for the current and prior fiscal year.

POST/api/partnerportal/getPartnerMetrics

Authorizations

x-auth-apikeystringheaderrequired

Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).

Authorizationstringheader

Instead of an API key, an OAuth access token: Bearer <token>, with the read scope.

OAuth explains tokens and scopes.

Headers

x-auth-schemeenum<string>headerdefault: partner-api-token

Authentication scheme identifier. Use api-token or partner-api-token with the x-auth-apikey header, api or partner-api with x-auth-apikey plus a client certificate, api-oauth-token or partner-api-oauth-token with x-auth-access-token, and federated-token with x-auth-ft. A request with Authorization: Bearer <token> and no x-auth-scheme is treated as OAuth, and federated-token may also be sent as the x-auth-scheme and x-auth-ft query parameters.

Available options: api-token, api, api-oauth-token, federated-token, partner-api-token, partner-api, partner-api-oauth-token

Body

application/json · object

Request object for getting the Salesforce scorecard belonging to the authenticated partner organization.

bash

curl --request POST \
  --url 'https://api2.rhombussystems.com/api/partnerportal/getPartnerMetrics' \
  --header 'x-auth-scheme: partner-api-token' \
  --header 'x-auth-apikey: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{}'

import requests

url = "https://api2.rhombussystems.com/api/partnerportal/getPartnerMetrics"
headers = {
    "x-auth-scheme": "partner-api-token",
    "x-auth-apikey": "YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
print(response.json())

const response = await fetch('https://api2.rhombussystems.com/api/partnerportal/getPartnerMetrics', {
  method: 'POST',
  headers: {
    'x-auth-scheme': 'partner-api-token',
    'x-auth-apikey': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);

console.log(await response.json());

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        String body = """
            {}
            """;
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api2.rhombussystems.com/api/partnerportal/getPartnerMetrics"))
            .header("x-auth-scheme", "partner-api-token")
            .header("x-auth-apikey", "YOUR_API_KEY")
            .header("Content-Type", "application/json")
            .method("POST", HttpRequest.BodyPublishers.ofString(body))
            .build();
        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.statusCode() + " " + response.body());
    }
}

json

{
  "error": false,
  "errorCode": "<string>",
  "metrics": {
    "activeRcdpCertifications": 0,
    "activeRcspCertifications": 0,
    "activeRctpCertifications": 0,
    "lastFyDealRegistrationSubmissions": 0,
    "lastFyEligibleBillings": 0,
    "lastFyNewBizConvertedDealRegistrations": 0,
    "lastFyNewBizDrEligibleBillings": 0,
    "lastFyNewLogosWon": 0,
    "ytdDealRegistrationSubmissions": 0,
    "ytdEligibleBillings": 0,
    "ytdNewBizConvertedDealRegistrations": 0,
    "ytdNewBizDrEligibleBillings": 0,
    "ytdNewLogosWon": 0
  }
}

Response

200 OK

application/json · object

Response object containing the Salesforce scorecard belonging to the authenticated partner organization.

errorboolean | null

errorCodestring | null

Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.

errorMsgstring | null

metricsobject

Salesforce scorecard for a partner organization: active certifications, eligible billings, new logos won and deal registration activity for the current and prior fiscal year.

Show child attributes

activeRcdpCertificationsinteger<int32> | null

Number of reps at the partner who currently hold an active RCDP (Rhombus Certified Design Professional) certification

activeRcspCertificationsinteger<int32> | null

Number of reps at the partner who currently hold an active RCSP (Rhombus Certified Sales Professional) certification

activeRctpCertificationsinteger<int32> | null

Number of reps at the partner who currently hold an active RCTP (Rhombus Certified Technical Professional) certification

lastFyDealRegistrationSubmissionsinteger<int32> | null

Number of deal registrations submitted by the partner over the whole of the prior fiscal year. Sourced from a Last_YTD_* Salesforce field, but the value covers the last fiscal year rather than a trailing twelve month window

lastFyEligibleBillingsnumber | null

Last FY Eligible Billings: eligible billings for the partner over the whole of the prior fiscal year. Sourced from the Salesforce field Last_YTD_Revenue__c, whose API name is misleading on two counts - its label is "Last FY Eligible Billings", so it is billings rather than revenue, and it covers the last fiscal year rather than a trailing twelve month window

lastFyNewBizConvertedDealRegistrationsinteger<int32> | null

Number of the partner's new business deal registrations converted over the whole of the prior fiscal year. Sourced from a Last_YTD_* Salesforce field, but the value covers the last fiscal year rather than a trailing twelve month window

lastFyNewBizDrEligibleBillingsnumber | null

Last FY NL DR Eligible Billings: the portion of the prior fiscal year's eligible billings attributable to new business deal registrations. Sourced from the Salesforce field Last_YTD_NL_DR_Revenue__c, whose API name is misleading on two counts - its label is "Last FY NL DR Eligible Billings", so it is billings rather than revenue, and it covers the last fiscal year rather than a trailing twelve month window

lastFyNewLogosWoninteger<int32> | null

Number of new logos won by the partner over the whole of the prior fiscal year. Sourced from a Last_YTD_* Salesforce field, but the value covers the last fiscal year rather than a trailing twelve month window

ytdDealRegistrationSubmissionsinteger<int32> | null

Number of deal registrations submitted by the partner so far this fiscal year

ytdEligibleBillingsnumber | null

YTD Eligible Billings: eligible billings for the partner so far this fiscal year. Sourced from the Salesforce field YTD_Revenue__c, whose API name is misleading - its label is "YTD Eligible Billings" and it is billings, not revenue

ytdNewBizConvertedDealRegistrationsinteger<int32> | null

Number of the partner's new business deal registrations converted so far this fiscal year

ytdNewBizDrEligibleBillingsnumber | null

YTD New Biz DR Eligible Billings: the portion of this fiscal year's eligible billings attributable to new business deal registrations. Sourced from the Salesforce field YTD_NL_DR_Revenue__c, whose API name is misleading - its label is "YTD New Biz DR Eligible Billings" and it is billings, not revenue

ytdNewLogosWoninteger<int32> | null

Number of new logos won by the partner so far this fiscal year

warningMsgstring | null

Errors

Like every operation, this one can also answer with the standard error body (errorCode, errorMsg). Errors explains each status and how to retry.

400 Bad Request. errorCode is one of: BAD_REQUEST, VALIDATION_FAILED, MISSING_REQUIRED_FIELD, INVALID_JSON, INVALID_REQUEST_BODY, FEATURE_NOT_ENABLED, INVALID_AUTH_ORG, LOCATION_NOT_FOUND, SELF_PROVISIONING_DISABLED, SKU_NOT_ALLOWED, QUANTITY_INVALID, AUTO_RENEW_REQUIRED, PROVISION_CAP_EXCEEDED, ACKNOWLEDGEMENT_REQUIRED, SIGNATURE_REQUIRED, APEX_VALIDATION, SKU_NOT_IN_PRICEBOOK.
401 Unauthorized. errorCode is one of: UNAUTHENTICATED, INVALID_CREDENTIAL, CREDENTIAL_EXPIRED, CREDENTIAL_REVOKED, CERTIFICATE_MISMATCH.
403 Forbidden. errorCode is one of: FORBIDDEN, DOMAIN_NOT_ALLOWED, DEVICE_SCOPE_MISMATCH, ROLE_NOT_PERMITTED, FUNCTIONALITY_REQUIRED, PARTNER_FUNCTIONALITY_REQUIRED, PERMISSION_REQUIRED, PARTNER_CLIENT_ACCESS_DENIED, HARDWARE_NOT_AVAILABLE, HARDWARE_ALREADY_REGISTERED, PARTNER_PORTAL_NOT_ENABLED, MANAGED_BY_MSP, SUPER_ADMIN_RESTRICTED_BY_MSP, MSP_DESIGNATION_INVALID, NOT_MANAGED_CLIENT, NOT_VERIFIED_MSP, ORDER_NOT_YOURS.
429 Too Many Requests. errorCode is one of: RATE_LIMITED, QUOTE_RATE_LIMITED.
500 Internal Server Error. errorCode is one of: INTERNAL_ERROR.
503 Service Unavailable. errorCode is one of: SERVICE_UNAVAILABLE, SALESFORCE_UNAVAILABLE.