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
    • 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 Team Data (beta)

PreviousUploading Test DataNextRepositories

Last updated 1 month ago

Teams are groups of contributors that can collaborate and are managed collectively. These APIs allow you to set up and manage your teams on your domain.

Importing Teams Data

Important: Ensure your has the manage:team scope when calling Teams APIs.

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

  • Teams should have unique names.

  • New members will automatically be added as contributors into your Logilica instance.

  • The administrator of the team is assigned to the owner of the API token.

  • For parent teams, include the subTeams field and use the GET Teams API to obtain the team's ID.

Upload Example Using cURL

In the following, we provide an example of how to push your Teams data into Logilica for storage and built-in analytics.

Important: Ensure the repository you build from is already onboarded in Logilica.

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/teams/create' \
--header 'X-lgca-token: lgca_UeRxFs_3RYRJEJtdYp7j7Wa6DirG5NjiYslsb' \
--header 'x-lgca-domain: myworkspace' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Development Team",
    "members": [{
        "name": "John Doe",
        "email": "john.doe@org.com"
    },
    {
        "name": "Jane Doe,
        "email": "jane.doe@org.com"
    }],
    "subTeams": ["1234567"]
}'

API Schema for Importing Team

Create a Team

Update a Team

Delete a Team

List Teams

List Contributors

API token
post

Delete a team

Path parameters
teamIDstringRequired
Responses
200
Success
application/json
400
Data given doesn't match schema. Return value will be ZodError with validation message
401
Unauthorized
404
Team not found
application/json
500
Failed to process request
application/json
post
POST /api/import/v1/teams/delete/{teamID} HTTP/1.1
Host: logilica.io
Accept: */*
{
  "message": "text"
}
get

List the teams in a domain

Responses
200
Success in retrieving teams
application/json
400
Data given doesn't match schema. Return value will be ZodError with validation message
401
Unauthorized
404
Team not found
application/json
get
GET /api/import/v1/teams/ HTTP/1.1
Host: logilica.io
Accept: */*
{
  "name": "text",
  "members": [
    {
      "name": "text",
      "email": "text"
    }
  ],
  "subTeams": [
    "text"
  ]
}
  • Importing Teams Data
  • Upload Example Using cURL
  • API Schema for Importing Team
  • Create a Team
  • POSTteams/create
  • Update a Team
  • POSTteams/update/{teamID}
  • Delete a Team
  • POSTteams/delete/{teamID}
  • List Teams
  • GETteams/
  • List Contributors
post

Create a team

Body
namestringRequired

Name of the team

subTeamsstring[]Optional

The sub teams within the team

Responses
200
Success
application/json
400
Data given doesn't match schema. Return value will be ZodError with validation message
401
Unauthorized
404
Team not found
application/json
500
Failed to process request
application/json
post
POST /api/import/v1/teams/create HTTP/1.1
Host: logilica.io
Content-Type: application/json
Accept: */*
Content-Length: 78

{
  "name": "text",
  "members": [
    {
      "name": "text",
      "email": "text"
    }
  ],
  "subTeams": [
    "text"
  ]
}
{
  "message": "text"
}
post

Update a team

Path parameters
teamIDstringRequired
Body
namestringRequired

Name of the team

subTeamsstring[]Optional

The sub teams within the team

Responses
200
Success
application/json
400
Data given doesn't match schema. Return value will be ZodError with validation message
401
Unauthorized
404
Team not found
application/json
500
Failed to process request
application/json
post
POST /api/import/v1/teams/update/{teamID} HTTP/1.1
Host: logilica.io
Content-Type: application/json
Accept: */*
Content-Length: 78

{
  "name": "text",
  "members": [
    {
      "name": "text",
      "email": "text"
    }
  ],
  "subTeams": [
    "text"
  ]
}
{
  "message": "text"
}