Uploading Contributors Data

Contributors are individuals linked across third-party accounts (e.g. GitHub, Jira and others) whose activity is explored in Logilica. The platform allows you to merge and manage these identities to provide a unified view of contributor activity across tools.

These APIs allow you to set up, manage and view your contributors and their accounts on your domain.

Importing Contributors Data

When creating contributors using the /create API, the associated accounts of the user from the body request will be strictly reflected in Logilica. Accounts will be merged or unmerged with contributors, depending on the body's request.

To ensure the accuracy of data in Logilica, Contributors data should adhere to the following:

• The service field should be one of the accepted services. The accepted services are:

  GitHub, GitLab, Git, Jira, AzureDevops, BitBucket, CircleCi, CodeCov, BuildKite

• If the target contributor does not exist, a new contributor will be added to the domain.

• If the contributor's account does not have an email, an empty string email: "" can be entered as a placeholder.

Valid accounts must be linked to imported services in the Logilica platform. Please import the services linked to the account first, before adding the account to the user.

Upload Example Using cURL

The cURL POST command is below. Note, that the POST command uses example data, including the API token lgca_UeRxFs_3RYRJEJtdYp7j7Wa6DirG5NjiYslsb and the example workspace myworkspace.

curl --location --request POST 'https://logilica.io/api/import/v1/contributors/create' \
--header 'X-lgca-token: lgca_UeRxFs_3RYRJEJtdYp7j7Wa6DirG5NjiYslsb' \
--header 'x-lgca-domain: myworkspace' \
--header 'Content-Type: application/json' \
--data-raw '[{
    "name": "John Doe",
    "email": "[e-mail]",
    "accounts": [{
        "service": "GitHub",
        "username": "johndoe",
        "email": "[e-mail]"
    },
    {
        "service": "Jira",
        "username": "[e-mail]",
        "email": "[e-mail]"
    }]
}]'

API Schema for Contributors

Create Contributors

post

Create or merge contributors with third party accounts

Bodyobject[]

namestringRequired

The full name of the contributor

emailstringRequired

The email address of the contributor

Responses

200

Success

application/json

messagestringRequired

400

Data given doesn't match schema. Return value will be ZodError with validation message

401

Unauthorized

404

Contributors not found

application/json

500

Failed to process request

application/json

postcontributors/create

POST /api/import/v1contributors/create HTTP/1.1
Host: logilica.io/
Content-Type: application/json
Accept: */*
Content-Length: 99

[
  {
    "name": "text",
    "email": "text",
    "accounts": [
      {
        "service": "GitHub",
        "username": "text",
        "email": "text"
      }
    ]
  }
]

{
  "message": "text"
}

List Contributors

get

List the contributors in a domain

Responses

200

Success

application/json

messagestringRequired

400

Data given doesn't match schema. Return value will be ZodError with validation message

401

Unauthorized

404

Contributor not found

application/json

500

Failed to process request

application/json

getcontributors/

GET /api/import/v1contributors/ HTTP/1.1
Host: logilica.io/
Accept: */*

{
  "message": "text"
}