Pulse Ingestion API v0.1.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

API to push data to Pulse.

Base URLs:

• https://ingestion.pulse.codacy.com/v1

Email: Pulse Support

Authentication

• API Key (APIKey)
  • Parameter Name: api_key, in: query.

ingestion

Use the Pulse Ingestion API to push data about your software delivery workflow events to Pulse.

pushAccelerateData

Code samples

# You can also use wget
curl -X POST https://ingestion.pulse.codacy.com/v1/ingestion/cli?api_key=HqsnRvQD3af9Pm45BUALwZpnLKVBSQpQLGzCGU6McPlqsyHQZSV%2BsQ%3D%3D \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

const inputBody = '{
  "deploy_id": "string",
  "time_created": "2020-11-09T09:10:00Z",
  "changes": [
    "string"
  ],
  "teams": [
    "jupiter",
    "mercury"
  ],
  "source": "api",
  "$type": "deployment"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('https://ingestion.pulse.codacy.com/v1/ingestion/cli?api_key=HqsnRvQD3af9Pm45BUALwZpnLKVBSQpQLGzCGU6McPlqsyHQZSV%2BsQ%3D%3D',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://ingestion.pulse.codacy.com/v1/ingestion/cli", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('https://ingestion.pulse.codacy.com/v1/ingestion/cli', params={
  'api_key': 'HqsnRvQD3af9Pm45BUALwZpnLKVBSQpQLGzCGU6McPlqsyHQZSV+sQ=='
}, headers = headers)

print(r.json())

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'https://ingestion.pulse.codacy.com/v1/ingestion/cli',
  params: {
  'api_key' => 'string'
}, headers: headers

p JSON.parse(result)

URL obj = new URL("https://ingestion.pulse.codacy.com/v1/ingestion/cli?api_key=HqsnRvQD3af9Pm45BUALwZpnLKVBSQpQLGzCGU6McPlqsyHQZSV%2BsQ%3D%3D");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

POST /ingestion/cli

Push data to Pulse about changes, deployments, and incidents for calculating the key metrics from Accelerate.

Body parameter

{
  "deploy_id": "string",
  "time_created": "2020-11-09T09:10:00Z",
  "changes": [
    "string"
  ],
  "teams": [
    "jupiter",
    "mercury"
  ],
  "source": "api",
  "$type": "deployment"
}

Parameters

Example responses

400 Response

{
  "message": "string",
  "error": "OK"
}

Responses

pushData

Code samples

# You can also use wget
curl -X POST https://ingestion.pulse.codacy.com/v1/ingestion/{provider}?api_key=HqsnRvQD3af9Pm45BUALwZpnLKVBSQpQLGzCGU6McPlqsyHQZSV%2BsQ%3D%3D \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

const inputBody = '{}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('https://ingestion.pulse.codacy.com/v1/ingestion/{provider}?api_key=HqsnRvQD3af9Pm45BUALwZpnLKVBSQpQLGzCGU6McPlqsyHQZSV%2BsQ%3D%3D',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://ingestion.pulse.codacy.com/v1/ingestion/{provider}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('https://ingestion.pulse.codacy.com/v1/ingestion/{provider}', params={
  'api_key': 'HqsnRvQD3af9Pm45BUALwZpnLKVBSQpQLGzCGU6McPlqsyHQZSV+sQ=='
}, headers = headers)

print(r.json())

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'https://ingestion.pulse.codacy.com/v1/ingestion/{provider}',
  params: {
  'api_key' => 'string'
}, headers: headers

p JSON.parse(result)

URL obj = new URL("https://ingestion.pulse.codacy.com/v1/ingestion/{provider}?api_key=HqsnRvQD3af9Pm45BUALwZpnLKVBSQpQLGzCGU6McPlqsyHQZSV%2BsQ%3D%3D");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

POST /ingestion/{provider}

Push an event to Pulse from one of the supported integration providers. Currently, Pulse supports the providers GitHub and PagerDuty.

Body parameter

{}

Parameters

Enumerated Values

Example responses

400 Response

{
  "message": "string",
  "error": "OK"
}

Responses

Schemas

EventSource

"api"

Source of the event.

Properties

Enumerated Values

Deployment

{
  "deploy_id": "string",
  "time_created": "2020-11-09T09:10:00Z",
  "changes": [
    "string"
  ],
  "teams": [
    "jupiter",
    "mercury"
  ],
  "source": "api",
  "$type": "deployment"
}

Details of a deployment.

Properties

Enumerated Values

Change

{
  "change_id": "string",
  "time_created": "2020-11-09T09:10:00Z",
  "source": "api",
  "$type": "change"
}

Details of a change.

Properties

Enumerated Values

Incident

{
  "incident_id": "string",
  "time_created": "2020-11-09T09:10:00Z",
  "time_resolved": "2020-11-09T09:10:00Z",
  "source": "api",
  "$type": "incident"
}

Details of an incident.

Properties

Enumerated Values

Event

{
  "deploy_id": "string",
  "time_created": "2020-11-09T09:10:00Z",
  "changes": [
    "string"
  ],
  "teams": [
    "jupiter",
    "mercury"
  ],
  "source": "api",
  "$type": "deployment"
}

Details of an event.

Properties

oneOf

xor

xor

ApiError

{
  "message": "string",
  "error": "OK"
}

Properties

Enumerated Values