Get Participation

GET

/api/v1/collective/participation

const url = 'https://api.ultimateteam.ai/api/v1/collective/participation';
const options = {method: 'GET', headers: {'X-API-Key': '<X-API-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.ultimateteam.ai/api/v1/collective/participation \
  --header 'X-API-Key: <X-API-Key>'

Authorizations

ApiKeyAuth

Responses

200

Successful Response

application/json

ParticipationResponse

object

consent

required

Any of:

ConsentResponse
null

ConsentResponse

object

accepted_at

required

Accepted At

string format: date-time

enabled

required

Enabled

boolean

industry

required

Industry

string

last_published_at

required

Any of:

string
null

string format: date-time

metric_names

required

Metric Names

Array<string>

policy_version

required

Policy Version

string

withdrawn_at

required

Any of:

string
null

string format: date-time

dispatch_pending

Any of:

boolean
null

boolean

observations

required

Observations

Array<object>

ObservationResponse

object

created_at

required

Created At

string format: date-time

required

string format: uuid

metric_name

required

Metric Name

string

metric_value

required

Metric Value

number

metric_variant

required

Metric Variant

string

period

required

Period

string

policy_version

required

Policy Version

string

request_id

required

Request Id

string format: uuid

source_kind

required

Source Kind

string

Allowed values: owner_attested native_receipt

unit

required

Unit

string

window_end

required

Window End

string format: date

window_start

required

Window Start

string format: date

Example

{
  "observations": [
    {
      "source_kind": "owner_attested"
    }
  ]
}