Uploading CI Build Data

Upload Example Using cURL

In the following, we provide an example of how to push your build-run information to 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 includes the example API token lgca_UeRxFs_3RYRJEJtdYp7j7Wa6DirG5NjiYslsb and the example workspace myworkspace. The command URL also includes a placeholder for the repoID to associate the uploaded issues with.

curl --location --request POST 'https://logilica.io/api/import/v1/ci_build/<repoID>/create' \
--header 'X-lgca-token: lgca_UeRxFs_3RYRJEJtdYp7j7Wa6DirG5NjiYslsb' \
--header 'x-lgca-domain: myworkspace' \
--header 'Content-Type: application/json' \
--data-raw '[{
  "origin": "GITHUB_TEST",
  "originalID": "1691121120",
  "name": "Pull Request CI",
  "url": "https://github.com/logilica/example/actions/runs/1691121120",
  "createdAt": 1689207410,
  "startedAt": 1689208510,
  "completedAt": 1689209716,
  "triggeredBy": {
    "name": "Joe Doe",
    "email": "[e-mail]",
    "accountId": "joe-doe",
    "lastActivity": 1679528275
  },
  "status": "completed",
  "conclusion": "success",
  "repoUrl" : "https://github.com/logilica/example",
  "commit": "c3de81aedf8461324021d61f4dca16dd742db215",
  "pullRequestUrls": [],
  "isDeployment": false,
  "stages": [
    {
      "id" : "4799033011",
      "name": "build / Build Logilica Insights",
      "startedAt": 1689208510,
      "completedAt": 1689209716,
      "status": "completed",
      "conclusion": "success",
      "url": "https://github.com/logilica/example/runs/4799033011?check_suite_focus=true",
      "jobs": [
        {
          "startedAt": 1689208510,
          "completedAt": 1689208540,
          "name": "Set up job",
          "status": "completed",
          "conclusion": "success"
        },
        {
          "startedAt": 1689208545,
          "completedAt": 1689209716,
          "name": "Run actions/checkout@v2",
          "status": "completed",
          "conclusion": "success"
        }
      ]
    }
  ]
}]'

API Schema for Importing CI Build Data

Create or update a CI build

POSThttps://logilica.io/api/import/v1/ci_build/{repoID}/create

Path parameters

repoID*string

Body

application/json

origin*string

The service / app that the build pipeline belongs to, e.g. 'GITHUB', 'GITLAB'

originalID*string

The ID of this build job with the service origin

name*string

Name of the CI build

url*string (uri)

The URL to which this CI build may be accessed

startedAt*number

UNIX timestamp of when the CI build began running

createdAt*number

UNIX timestamp of when the CI build was submitted

completedAt*number

UNIX timestamp of when the CI build ended

triggeredBy*object

Details of person who triggered the build

status*string

Status of the CI build, e.g. 'Completed', 'Running'

conclusion*string

Outcome of the CI build, e.g. 'Success', 'Fail'

repoUrl*string (uri)

URL for the git repository this belongs to

commit*string

The git commit hash that identifies the git commit this workflow run corresponds to

pullRequestUrls*array of string

An array of URLs of pull requests that are linked to this CI build

isDeployment*boolean

Boolean indicating whether the CI build is a deployment run or not

stages*array of object

An array of CI build stages

Response

200400401404

Success in creating CI build

Body

application/json

warningsobject

Request

JavaScriptCurlPython

const response = await fetch('https://logilica.io/api/import/v1/ci_build/{repoID}/create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {
        "origin": "text",
        "originalID": "text",
        "name": "text",
        "url": "https://example.com",
        "startedAt": 0,
        "createdAt": 0,
        "completedAt": 0,
        "triggeredBy": {
          "name": "text",
          "accountId": "text",
          "lastActivity": 0
        },
        "status": "text",
        "conclusion": "text",
        "repoUrl": "https://example.com",
        "commit": "text",
        "pullRequestUrls": [
          "text"
        ],
        "isDeployment": false,
        "stages": [
          {
            "name": "text",
            "id": "text",
            "url": "https://example.com",
            "startedAt": 0,
            "completedAt": 0,
            "status": "text",
            "conclusion": "text",
            "jobs": [
              {
                "name": "text",
                "startedAt": 0,
                "completedAt": 0,
                "status": "text",
                "conclusion": "text"
              }
            ]
          }
        ]
      }
    ]),
});
const data = await response.json();

Response

200404

{
  "warnings": {
    "message": "text",
    "ids": [
      "text"
    ]
  }
}

Questions?

If you have any questions or run into issues, please contact us at [e-mail].