Competition Leaders

Competition statistical leaders are a list of persons for a statistic ranked from highest to lowest across an entire competition (multi-season). Each season's own qualification rules are applied to that season's data before aggregating and ranking across seasons.

competition statistical leaders

get
/handball/o/{organizationId}/statistics/leaders/for/{statistic}/in/competitions/{competitionId}

Return a list of the leading persons for a statistic in a competition, aggregated across all included seasons in that competition.

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
competitionIdstring · uuidRequired

The unique identifier of the competition

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

The unique identifier of the organization

Example: b1a23
statisticstring · max: 50Required

The name of the statistic

Example: points
Query parameters
entityIdstring · uuidOptional

The unique identifier of the entity

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
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)]
fixtureTypestring · enum · max: 50Optional

Type of Fixture

  • ALL_STAR All Star
  • DEMONSTRATION Demonstration
  • FINAL Final
  • FRIENDLY Friendly
  • PLAYOFF Playoff
  • PRESEASON Pre Season
  • REGULAR Regular
Example: REGULARPossible values:
hideNullbooleanOptional

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

Example: true
homeAwaystring · enum · max: 50Optional

Where the result was

  • AWAY Away
  • HOME Home
Possible values:
includestringOptional

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

Example: organizations,fixtures,entities
isPlayerbooleanOptional

Is the person a player?

isTeamOfficialbooleanOptional

Is the person a team official?

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
personIdstring · uuidOptional

The unique identifier of the person

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

Is the person a starter in the match ?

winLossstring · enum · max: 50Optional

What the result was

  • DRAW Draw
  • LOSS Loss
  • WIN Win
Possible values:
Responses
200

Successful operation

application/json
get
/handball/o/{organizationId}/statistics/leaders/for/{statistic}/in/competitions/{competitionId}

competition statistical leader summary

get
/handball/o/{organizationId}/statistics/leaders/in/competitions/{competitionId}

Return a summary of the leading persons for a number of statistics in a competition. Only the requested statistic is returned within the 'statistics' object of each row.

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
competitionIdstring · uuidRequired

The unique identifier of the competition

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

The unique identifier of the organization

Example: b1a23
Query parameters
entityIdstring · uuidOptional

The unique identifier of the entity

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
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)]
fixtureTypestring · enum · max: 50Optional

Type of Fixture

  • ALL_STAR All Star
  • DEMONSTRATION Demonstration
  • FINAL Final
  • FRIENDLY Friendly
  • PLAYOFF Playoff
  • PRESEASON Pre Season
  • REGULAR Regular
Example: REGULARPossible values:
hideNullbooleanOptional

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

Example: true
homeAwaystring · enum · max: 50Optional

Where the result was

  • AWAY Away
  • HOME Home
Possible values:
includestringOptional

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

Example: organizations,fixtures,entities
isPlayerbooleanOptional

Is the person a player?

isTeamOfficialbooleanOptional

Is the person a team official?

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
personIdstring · uuidOptional

The unique identifier of the person

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

Is the person a starter in the match ?

statisticsstringOptional

The name of the statistic. Can specify multiple, delimited by comma.

Example: points,minutes
winLossstring · enum · max: 50Optional

What the result was

  • DRAW Draw
  • LOSS Loss
  • WIN Win
Possible values:
Responses
200

Successful operation

application/json
get
/handball/o/{organizationId}/statistics/leaders/in/competitions/{competitionId}

Fast (pre-aggregated) competition statistical leaders

get
/handball/o/{organizationId}/statistics/leaders/for/{statistic}/in/competitions/{competitionId}/simple

Return pre-aggregated list of the leading persons for a statistic in a competition derived from the side table based on aggregated data across all included seasons in that competition.

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
competitionIdstring · uuidRequired

The unique identifier of the competition

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

The unique identifier of the organization

Example: b1a23
statisticstring · max: 50Required

The name of the statistic

Example: points
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)]
fixtureTypestring · enum · max: 50Optional

Type of Fixture

  • ALL_STAR All Star
  • DEMONSTRATION Demonstration
  • FINAL Final
  • FRIENDLY Friendly
  • PLAYOFF Playoff
  • PRESEASON Pre Season
  • REGULAR Regular
Example: REGULARPossible values:
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
200

Successful operation

application/json
get
/handball/o/{organizationId}/statistics/leaders/for/{statistic}/in/competitions/{competitionId}/simple

Fast (pre-aggregated) competition statistical leader summary

get
/handball/o/{organizationId}/statistics/leaders/in/competitions/{competitionId}/simple

Return a summary {stat: rows} from the side table for the requested statistics.

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
competitionIdstring · uuidRequired

The unique identifier of the competition

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)]
fixtureTypestring · enum · max: 50Optional

Type of Fixture

  • ALL_STAR All Star
  • DEMONSTRATION Demonstration
  • FINAL Final
  • FRIENDLY Friendly
  • PLAYOFF Playoff
  • PRESEASON Pre Season
  • REGULAR Regular
Example: REGULARPossible values:
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
statisticsstringOptional

The name of the statistic. Can specify multiple, delimited by comma.

Example: points,minutes
Responses
200

Successful operation

application/json
get
/handball/o/{organizationId}/statistics/leaders/in/competitions/{competitionId}/simple

Build competition person leaders side table

post
/handball/o/{organizationId}/statistics/leaders/in/competitions/{competitionId}/build

Build pre-aggregated competition person leaders for a competition.

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
competitionIdstring · uuidRequired

The unique identifier of the competition

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
Responses
200

Successful operation

application/json
post
/handball/o/{organizationId}/statistics/leaders/in/competitions/{competitionId}/build

Build all competition person leaders (org)

post
/handball/o/{organizationId}/statistics/leaders/in/competitions/build

Build pre-aggregated competition person leaders for all competitions in an organization.

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
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
Responses
200

Successful operation

application/json
post
/handball/o/{organizationId}/statistics/leaders/in/competitions/build

List competition leaders configuration

get
/handball/admin/statistics/leaders/in/competitions/config

Return configuration rows that drive competition person leaders builds.

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:
Available scopes:
  • : Authenticate based on a specific OrganizationId
  • : Read data over multiple organizations using and *orggroup* code
  • : Write/Update any data from below the organization
  • : Read any data from the organization down
  • : Perform administration API calls
  • : Ability to manage organizations
  • : Perform system configuration API calls
Query parameters
competitionIdstring · uuidOptional

The unique identifier of the competition

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
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
organizationIdstring · min: 5 · max: 5Optional

The unique identifier of the organization

Example: b1a23
Responses
200

Successful operation

application/json
get
/handball/admin/statistics/leaders/in/competitions/config

Upsert competition person leaders configuration

post
/handball/admin/statistics/leaders/in/competitions/config

Insert or update competition person leaders configuration rows.

Required scopes
This endpoint requires the following scopes:
  • : Perform administration API calls
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:
Query parameters
competitionIdstring · uuidOptional

The unique identifier of the competition

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
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
organizationIdstring · min: 5 · max: 5Optional

The unique identifier of the organization

Example: b1a23
Body
competitionPersonLeadersConfigurationIdstring · uuidOptional

The unique identifier of the competition person leaders configuration row

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

The unique identifier of the organization

Example: b1a23
competitionIdstring · uuid | nullableOptional

The unique identifier of the competition (optional for org-wide config)

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
runEveryinteger · int32Optional

Minutes between scheduled builds (0 to always allow)

Responses
200

Successful operation

application/json
post
/handball/admin/statistics/leaders/in/competitions/config

Delete competition person leaders configuration

delete
/handball/admin/statistics/leaders/in/competitions/config

Remove competition person leaders configuration rows.

Required scopes
This endpoint requires the following scopes:
  • : Perform administration API calls
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:
Query parameters
competitionIdstring · uuidOptional

The unique identifier of the competition

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
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
organizationIdstring · min: 5 · max: 5Optional

The unique identifier of the organization

Example: b1a23
Responses
200

Successful operation

application/json
delete
/handball/admin/statistics/leaders/in/competitions/config

Build competition person leaders from configuration

post
/handball/admin/statistics/leaders/in/competitions/config/build

Trigger competition person leaders builds for configured organizations and competitions.

Required scopes
This endpoint requires the following scopes:
  • : Perform administration API calls
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:
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
competitionPersonLeadersConfigurationIdstring · uuidOptional

The unique identifier of the competition person leaders configuration row

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

The unique identifier of the organization

Example: b1a23
competitionIdstring · uuid | nullableOptional

The unique identifier of the competition (optional for org-wide config)

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
runEveryinteger · int32Optional

Minutes between scheduled builds (0 to always allow)

Responses
200

Successful operation

application/json
post
/handball/admin/statistics/leaders/in/competitions/config/build

Last updated

Was this helpful?