COUNTER support

If you syndicate your content to other platforms, GetFTR can help you combine on- and off-platform usage in your COUNTER reporting. By sharing your internal customer IDs through GetFTR, you enable participating platforms to associate usage with your institutional customers and report it back to you, giving you a more complete picture of how your content is used.

You can share customer IDs through your entitlement API or your Google Subscriber Links Archive. In either case, use the same institutional customer IDs that you use to identify customers in your usage reporting, so that usage from participating platforms can be matched to your records.

Include your internal customer ID in the org.customerID property of each relevant entitlement response. For example:


{
  "entitlements": [
    {
      "doi": "10.1234/example",
      "statusCode": 200,
      "entitled": "yes",
      "accessType": "paid",
      "source": "service_request",
      "org": {
        "ipv4": "192.0.2.10",
        "customerID": "1234567890"
      },
      "document": "https://publisher.example/articles/example",
      "vor": [
        {
          "contentType": "text/html",
          "url": "https://publisher.example/articles/example/full"
        }
      ]
    }
  ]
}

Here, 1234567890 identifies the institutional customer whose entitlement was checked. Return it as a string, preserving any leading zeros.

If you use the Centralized Entitlements Service, you can share customer IDs through your Google Subscriber Links Archive without operating an entitlement API.

Use your internal customer ID as the id attribute of the corresponding <subscriber> element in subscribers.xml. For example:


<?xml version="1.0" encoding="UTF-8"?>
<subscribers>
  <subscriber id="1234567890">
    <institution>Example University</institution>
    <patron_ip_range>192.0.2.0-192.0.2.255</patron_ip_range>
    <electronic_subscriptions>
      <url>https://publisher.example/subscriptions/1234567890.xml</url>
    </electronic_subscriptions>
  </subscriber>
</subscribers>

The id attribute supplies the customer ID; the <institution> element supplies the institution’s name. The subscription URL points to the institution’s holdings file in your subscriber links archive.

Once your archive contains the customer IDs you use for usage reporting, indicate this in your configuration on the GetFTR Self-Service portal . This allows participating integrators to receive customer IDs from the Centralized Entitlements Service while retaining the benefits of centralized entitlement checking.

COUNTER support

Sharing customer IDs through your API

Sharing customer IDs through subscriber links