Get Policy

If you have created one or more Policies or are allowed to view one or more Policies:

Retrieve a Policy

/v2/policies/{policyId}

Response of a Policy

All requesters will receive a common set of attributes. Each requester will also receive the list of attributes that are role specific:

Common Attributes

• id
• name
• dataAvailableTime
• description
• datasourceId
• updateFrequency
• currencyType
• subscriptionFee
• subscriptionType
• licenseFile
• image
• status: policy status (Pending, Approved, Live, Rejected)
• subscriberCount: number of active subscribers
• subscriptionState: the status of your subscription (SUBSCRIBED, PENDING, null)
• publisher: email of the policy publisher
• publisherName: name of the policy publisher

Additional Subscriber Attributes

If you are an active subscriber of a policy, the response will also include:

• data: if the policy has published data, this field will contain the list of data file information. For each data file, the following variables are available in the response body:
  1. fileDate: in the format of YYYY-MM-DDThh:mm±hh:mm. Please refer to this ISO 8601 standard for more information
  2. fileName
  3. fileSize

Example:

{
    fileDate: "2021-10-19T13:31:31+00:00",
    fileName: "https://...",
    fileSize: 4503
}

Additional Publisher Attributes

If you are the publisher of a policy, the response will also include:

• datasourceName
• listed (whether policy is listed on the Catalog or delisted)
• rules
• reviewer: email of the reviewer
• reviewerName: name of the reviewer
• availableReportUsage: "true", if the subscriber usage report is available. Otherwise "false".

• subscribers: list of all active subscribers. format:

  [{ subscriber: "email of the subscriber", subscriberName: "name of the subscriber" },…]

Retrieve all Policies

You can retrieve the full list of all Policies that you own as well as the ones you are allowed to see by sending a GET request:

v2/policies/catalog?page=1&pageSize=10

The following parameters are available for pagination:

• Page: the page number to retrieve (optional, default and minimum value is 1)
• PageSize: number of pages to return (optional, default is 10 Policies per page 10)
• Name: filter the list of Policies by name (optional)

Response of a list of Policies

totalPages - number of total pages list - a list of Policies. Each policy contains:

• id
• name
• category
• status
• subCategory
• subscriberCount

Get Usage Report

If you are a policy creator and wish to get the usage data of your subscribers to your policy, you can send a GET request to

/v2/policies/{policyId}/reports/usage

You will need the Id of the policy you are request the usage report from. The response will be an excel file containing the usage report.

---

Last update: April 5, 2023