SHsheerid
report

List reporting fields

Changed on

Retrieve a list of reporting fields available to the user's account and the programs requested

get/report/fields

Request

  • Base URL
    https://services.sheerid.com/rest/v2
  • Auth
    HTTP bearer

Query parameters

programIdsstring[]

List of program ids for which to retrieve metadata keys. If none are specified all programs under the user's account are included.

Response

A list of reporting fields organized by scope.

scope'STANDARD' | 'PII' | 'METADATA' required

The scope to which the set of fields belong. Possible values are: * STANDARD - The base fields available to all reports. * PII - The fields containing personally identifiable information that are available to the user's account. * METADATA - The default and custom metadata fields available to the user's account and programs.

Changes

  • 2373facbc1c2Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • bf4b86260e69Revision changes
    • warning

      added the new inCountryVerification enum value to the response property for the response status

    • warning

      added the new inCountryVerification enum value to the response property for the response status

    • warning

      added the new inCountryVerification enum value to the response property for the response status