Sign in

v1

latestOpenAPI 3.0.02026-08-066425196.1 KB
Contributions

Get contribution data directly from the database.

Get contribution data directly from the database. Returns a JSON result.

get/contributions/

Query parameters

userIdstring

Contributor's unique identifier which maps to the record.contributor.userId field

statusstring

Contribution's status which maps to the status field in the MySQL database

contributionTypestring

Contribution type which maps to the contributionType field in the MySQL database

targetNaIdstring

Contribution's target record's unique identifier which maps to the targetNaId field in the MySQL database

createdAtstring

Contribution's date of creation by which to filter

updatedAtstring

Contribution's date of modification by which to filter

sortBy'contribution.asc' | 'contribution.desc' | 'createdAt.asc' | 'createdAt.desc' | 'updatedAt.asc' | 'updatedAt.desc'

Sort order:

  • contribution.asc - Sort by contribution, ascending from A to Z
  • contribution.desc - Sort by contribution, descending from Z to A
  • createdAt.asc - Sort by created date, ascending
  • createdAt.desc - Sort by created date, descending
  • updatedAt.asc - Sort by updated date, ascending
  • updatedAt.desc - Sort by updated date, descending
  • count.asc - Sort by aggregated tag counts, ascending, ONLY works when contributionType = tag is present
  • count.desc - Sort by aggregated tag counts, descending, ONLY works when contributionType = tag is present
includeTotalCountboolean

Returns the total count of results in each result.

Response

A body of response data containing contribution data from the database if any were found.