Leader Qualifiers

These functions allow the addition/management of specific qualifications into a criteria set to determine whether a person is a leader in a statistical category.

Get a list of leader qualifiers for a criteria set

get
/baseball/o/{organizationId}/statistics/leaders/criteria/{leaderCriteriaId}/qualifiers

Return a list of leader qualifiers

Required scopes
This endpoint requires the following scopes:
  • : Read any data from the organization down
Authorizations
OAuth2clientCredentialsRequired

You can create a JSON Web Token (JWT) using the token API call. Each token is given a set of scopes/permissions. Each endpoint has a scope/permission that it requires to run. If your token does not possess the correct scope then you will be unable to make the API call.

Token URL:
Path parameters
leaderCriteriaIdstring · uuidRequired

The unique identifier of the leader criteria

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
organizationIdstring · min: 5 · max: 5Required

The unique identifier of the organization

Example: b1a23
Query parameters
externalstringOptional

A comma separated list of fields that will instead be interpreted as an externalId. See External Ids for more information.

Example: entityId,personId
fieldsstringOptional

A comma separated list of fields to display. The response will only display these fields. See Partial Response section for more information.

Example: dob,firstName,organization(id),organizations[name], teams[name,details/metrics/*,tags(id)]
hideNullbooleanOptional

Don't display data fields with null values or empty structures

Example: true
includestringOptional

A comma separated list of resource types to include. See Resource Inclusion for more information.

Example: organizations,fixtures,entities
limitinteger · int32 · min: 1 · max: 1000Optional

The maximum number of records to return. See Pagination for more information.

Default: 10Example: 10
offsetinteger · int32Optional

The offset of the records. See Pagination for more information.

Example: 10
statisticFieldstring · max: 50Optional

The name of the statistic

Example: points
Responses
default

Error

application/json
get
/baseball/o/{organizationId}/statistics/leaders/criteria/{leaderCriteriaId}/qualifiers

Create a new leader qualifier in a criteria set

post
/baseball/o/{organizationId}/statistics/leaders/criteria/{leaderCriteriaId}/qualifiers

Insert a new leader qualifier

Required scopes
This endpoint requires the following scopes:
  • : Write/Update any data from below the organization
Authorizations
OAuth2clientCredentialsRequired

You can create a JSON Web Token (JWT) using the token API call. Each token is given a set of scopes/permissions. Each endpoint has a scope/permission that it requires to run. If your token does not possess the correct scope then you will be unable to make the API call.

Token URL:
Path parameters
leaderCriteriaIdstring · uuidRequired

The unique identifier of the leader criteria

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
organizationIdstring · min: 5 · max: 5Required

The unique identifier of the organization

Example: b1a23
Query parameters
externalstringOptional

A comma separated list of fields that will instead be interpreted as an externalId. See External Ids for more information.

Example: entityId,personId
fieldsstringOptional

A comma separated list of fields to display. The response will only display these fields. See Partial Response section for more information.

Example: dob,firstName,organization(id),organizations[name], teams[name,details/metrics/*,tags(id)]
hideNullbooleanOptional

Don't display data fields with null values or empty structures

Example: true
includestringOptional

A comma separated list of resource types to include. See Resource Inclusion for more information.

Example: organizations,fixtures,entities
Body
qualifierIdstring · uuidOptional

The unique identifier of the leader qualifier

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
leaderCriteriaIdstring · uuidRequired

The unique identifier of the LeaderCriteria

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
statisticFieldstringRequired

The statistic field that this qualifier is for.

comparisonFieldstringRequired

The statistic field to compare against.

comparisonTypestring · enumRequired

Comparison type for the qualifier

  • EQUAL Equal
  • GREATER_THAN Greater than
  • GREATER_THAN_EQUAL Greater than or equal
  • LESS_THAN Less than
  • LESS_THAN_EQUAL Less than or equal
Example: GREATER_THANPossible values:
comparisonValuenumber · floatRequired

Comparison value for the qualifier

Responses
default

Error

application/json
post
/baseball/o/{organizationId}/statistics/leaders/criteria/{leaderCriteriaId}/qualifiers

Get a specific leader qualifier

get
/baseball/o/{organizationId}/statistics/leaders/criteria/{leaderCriteriaId}/qualifiers/{qualifierId}

Return detailed information about a specific leader qualifier

Required scopes
This endpoint requires the following scopes:
  • : Read any data from the organization down
Authorizations
OAuth2clientCredentialsRequired

You can create a JSON Web Token (JWT) using the token API call. Each token is given a set of scopes/permissions. Each endpoint has a scope/permission that it requires to run. If your token does not possess the correct scope then you will be unable to make the API call.

Token URL:
Path parameters
leaderCriteriaIdstring · uuidRequired

The unique identifier of the leader criteria

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
organizationIdstring · min: 5 · max: 5Required

The unique identifier of the organization

Example: b1a23
qualifierIdstring · uuidRequired

The unique identifier of the leader qualifier

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
Query parameters
externalstringOptional

A comma separated list of fields that will instead be interpreted as an externalId. See External Ids for more information.

Example: entityId,personId
fieldsstringOptional

A comma separated list of fields to display. The response will only display these fields. See Partial Response section for more information.

Example: dob,firstName,organization(id),organizations[name], teams[name,details/metrics/*,tags(id)]
hideNullbooleanOptional

Don't display data fields with null values or empty structures

Example: true
includestringOptional

A comma separated list of resource types to include. See Resource Inclusion for more information.

Example: organizations,fixtures,entities
limitinteger · int32 · min: 1 · max: 1000Optional

The maximum number of records to return. See Pagination for more information.

Default: 10Example: 10
offsetinteger · int32Optional

The offset of the records. See Pagination for more information.

Example: 10
Responses
default

Error

application/json
get
/baseball/o/{organizationId}/statistics/leaders/criteria/{leaderCriteriaId}/qualifiers/{qualifierId}

Update a leader qualifier

put
/baseball/o/{organizationId}/statistics/leaders/criteria/{leaderCriteriaId}/qualifiers/{qualifierId}

Updates a specific leader qualifier

Required scopes
This endpoint requires the following scopes:
  • : Write/Update any data from below the organization
Authorizations
OAuth2clientCredentialsRequired

You can create a JSON Web Token (JWT) using the token API call. Each token is given a set of scopes/permissions. Each endpoint has a scope/permission that it requires to run. If your token does not possess the correct scope then you will be unable to make the API call.

Token URL:
Path parameters
leaderCriteriaIdstring · uuidRequired

The unique identifier of the leader criteria

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
organizationIdstring · min: 5 · max: 5Required

The unique identifier of the organization

Example: b1a23
qualifierIdstring · uuidRequired

The unique identifier of the leader qualifier

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
Query parameters
externalstringOptional

A comma separated list of fields that will instead be interpreted as an externalId. See External Ids for more information.

Example: entityId,personId
fieldsstringOptional

A comma separated list of fields to display. The response will only display these fields. See Partial Response section for more information.

Example: dob,firstName,organization(id),organizations[name], teams[name,details/metrics/*,tags(id)]
hideNullbooleanOptional

Don't display data fields with null values or empty structures

Example: true
includestringOptional

A comma separated list of resource types to include. See Resource Inclusion for more information.

Example: organizations,fixtures,entities
Body
leaderCriteriaIdstring · uuidOptional

The unique identifier of the LeaderCriteria

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
statisticFieldstringOptional

The statistic field that this qualifier is for.

comparisonFieldstringOptional

The statistic field to compare against.

comparisonTypestring · enumOptional

Comparison type for the qualifier

  • EQUAL Equal
  • GREATER_THAN Greater than
  • GREATER_THAN_EQUAL Greater than or equal
  • LESS_THAN Less than
  • LESS_THAN_EQUAL Less than or equal
Example: GREATER_THANPossible values:
comparisonValuenumber · floatOptional

Comparison value for the qualifier

Responses
default

Error

application/json
put
/baseball/o/{organizationId}/statistics/leaders/criteria/{leaderCriteriaId}/qualifiers/{qualifierId}

Delete leader qualifier

delete
/baseball/o/{organizationId}/statistics/leaders/criteria/{leaderCriteriaId}/qualifiers/{qualifierId}

Delete a specific leader qualifier

Required scopes
This endpoint requires the following scopes:
  • : Write/Update any data from below the organization
Authorizations
OAuth2clientCredentialsRequired

You can create a JSON Web Token (JWT) using the token API call. Each token is given a set of scopes/permissions. Each endpoint has a scope/permission that it requires to run. If your token does not possess the correct scope then you will be unable to make the API call.

Token URL:
Path parameters
leaderCriteriaIdstring · uuidRequired

The unique identifier of the leader criteria

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
organizationIdstring · min: 5 · max: 5Required

The unique identifier of the organization

Example: b1a23
qualifierIdstring · uuidRequired

The unique identifier of the leader qualifier

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
Query parameters
externalstringOptional

A comma separated list of fields that will instead be interpreted as an externalId. See External Ids for more information.

Example: entityId,personId
fieldsstringOptional

A comma separated list of fields to display. The response will only display these fields. See Partial Response section for more information.

Example: dob,firstName,organization(id),organizations[name], teams[name,details/metrics/*,tags(id)]
forceDeletebooleanOptional

Force a delete command to run and delete child records as well if there are existing records depending on the record.

Example: true
hideNullbooleanOptional

Don't display data fields with null values or empty structures

Example: true
includestringOptional

A comma separated list of resource types to include. See Resource Inclusion for more information.

Example: organizations,fixtures,entities
Responses
default

Error

application/json
delete
/baseball/o/{organizationId}/statistics/leaders/criteria/{leaderCriteriaId}/qualifiers/{qualifierId}

Last updated

Was this helpful?