Logilica Documentation
HomepageDemoBlogContact
  • About Logilica
    • Overview
  • Getting Started
    • Onboarding Data
    • Onboarding Users
    • Setting up Teams
  • Integration
    • Connecting Tools
    • Uploading Custom Data
  • Metrics & Reports
    • Introduction
      • Navigation
      • Dashboards
      • Data Exploration
    • Epics Delivery Tracker
    • Planning
      • Ticket Lead Time
      • Ticket Velocity
      • Ticket Overload
      • Sprint Health
      • Ticket Activities / Risks
    • Code
      • Code Cycle Time
      • Coding Velocity
      • Review Process
      • Developer Health
      • Code Activities / Risks
    • Build
    • Team Management
      • Teams Overview
      • Team Pulse
      • Activity Lens
    • Reports
    • Customization
    • Glossary
  • Configuration
    • User Management
    • Managing Contributors
    • Menu Management
    • Release Detection
    • Targets & Thresholds
    • DORA Configuration
  • Advanced
    • API Token Management
    • Import API
      • API Overview
      • Uploading Planning Data
      • Uploading CI Build Data
        • CDEvents Integration
      • Uploading Test Data
      • Uploading Team Data (beta)
      • Repositories
      • Uploading Contributors Data
    • Export API
    • DataStudio
      • Data Models
        • CI Build
        • CI Build Stage
        • Contributor
        • Coverage Commit
        • Coverage File
        • Coverage Label
        • Coverage Test Result
        • Jira Component
        • Jira Epic
        • Jira Hierarchy Issues
        • Jira Issue Hierarchy Link
        • Jira Issue
        • Jira Issue
        • Jira Label
        • Jira Project
        • Jira Release
        • Jira Sprint
        • Project
        • Pull Request
        • Pull Request
        • Release
        • Team
      • Advanced Transformations
    • Integrations: Data Mapping
      • GitHub Projects Support
  • SSO Integration
    • Keycloak SSO
  • Subprocessors
  • Changelog
Powered by GitBook
On this page
  1. Advanced
  2. Import API

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": "johndoe@test.com",
    "accounts": [{
        "service": "GitHub",
        "username": "johndoe",
        "email": "johndoe@github.com"
    },
    {
        "service": "Jira",
        "username": "johndoe@test.com",
        "email": "johndoe@test.com"
    }]
}]'

API Schema for Contributors

Create Contributors

List Contributors

PreviousRepositoriesNextExport API

Last updated 6 hours ago

get

List the contributors in a domain

Responses
200
Success
application/json
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
get
GET /api/import/v1/contributors/ HTTP/1.1
Host: logilica.io
Accept: */*
{
  "message": "text"
}
  • Importing Contributors Data
  • Upload Example Using cURL
  • API Schema for Contributors
  • Create Contributors
  • POSTcontributors/create
  • List Contributors
  • GETcontributors/
post

Create or merge contributors with third party accounts

Body
namestringRequired

The full name of the contributor

emailstringRequired

The email address of the contributor

Responses
200
Success
application/json
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
post
POST /api/import/v1/contributors/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"
}