Overview:

DELETE
/api/account
Delete an account

JSON parameters:


Input examples:

application/json:
{
    "username": "kibbleguest"
}

Response examples:

200:
{
    "message": "Action completed"
}
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}
PATCH
/api/account
Edit an account

JSON parameters:

password: (string) Desired password for the account
admin: (boolean) when adding users to orgs, this signifies ownership
displayname: (string) A display name (e.g. full name) for the account
email: (string) Desired username (email address)
defaultOrganisation: (string) If editing an account, this sets the default org (if a member of it)

Input examples:

application/json:
{
    "password": "kibbledemo",
    "admin": false,
    "displayname": "Kibble Guest",
    "email": "guest@kibble.live",
    "defaultOrganisation": "demo"
}

Response examples:

200:
{
    "message": "Action completed"
}
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}
PUT
/api/account
Create a new account

JSON parameters:

password: (string) Desired password for the account
displayname: (string) A display name (e.g. full name) for the account
email: (string) Desired username (email address)

Input examples:

application/json:
{
    "password": "kibbledemo",
    "displayname": "Kibble Guest",
    "email": "guest@kibble.live"
}

Response examples:

200:
{
    "message": "Action completed"
}
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}
GET
/api/bio/bio
Shows some facts about a contributor

JSON parameters:


Response examples:

200:
{}
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}
POST
/api/bio/bio
Shows some facts about a contributor

JSON parameters:

quick: (boolean) Turns on quick data for some endpoints, returning only sparse data (thus less traffic)
to: (integer) If specified, only compile data up until here
view: (string) ID Of optional view to use
sources: (boolean) for some widget, this fetches all sources
author: (boolean) Turns on author view for code results, as opposed to the default committer view
interval: (string) If fetching histograms, this specifies the interval to pack figures into. Can be day, week, month, quarter or year
subfilter: (string) Quickly defined view by sub-filtering the existing view and matching on sourceURLs
email: (string) filter sources based on an email (a person)
links: (integer) for relationship maps, this denotes the minimum link strength (no. of connections) that makes up a link.
search: (string) for some widgets, this enables sub-filtering based on searches
types: (array) If set, only return data from sources matching these types
span: (integer) For factor charts, denotes the number of months to base factors on from
distinguish: (boolean) Enables distinguishing different types of data objects, subject to the individual API endpoint
from: (integer) If specified, compile data from this timestamp onwards
collapse: (string) for some widgets, this collapses sources based on a regex
source: (string) If specified, only compile data on this specific sourceID
unique: (boolean) Only compile data from unique commits, ignore duplicates

Input examples:

application/json:
{
    "interval": "month",
    "quick": false,
    "to": 1503483273,
    "span": 2,
    "types": [
        "jira",
        "bugzilla"
    ],
    "view": "abcdef12345678",
    "distinguish": false,
    "from": 1400000000,
    "source": "abcdef12345678"
}

Response examples:

200:
{}
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}
POST
/api/bio/trends
Shows a quick trend summary of the past 6 months for a contributor

JSON parameters:

quick: (boolean) Turns on quick data for some endpoints, returning only sparse data (thus less traffic)
to: (integer) If specified, only compile data up until here
view: (string) ID Of optional view to use
sources: (boolean) for some widget, this fetches all sources
author: (boolean) Turns on author view for code results, as opposed to the default committer view
interval: (string) If fetching histograms, this specifies the interval to pack figures into. Can be day, week, month, quarter or year
subfilter: (string) Quickly defined view by sub-filtering the existing view and matching on sourceURLs
email: (string) filter sources based on an email (a person)
links: (integer) for relationship maps, this denotes the minimum link strength (no. of connections) that makes up a link.
search: (string) for some widgets, this enables sub-filtering based on searches
types: (array) If set, only return data from sources matching these types
span: (integer) For factor charts, denotes the number of months to base factors on from
distinguish: (boolean) Enables distinguishing different types of data objects, subject to the individual API endpoint
from: (integer) If specified, compile data from this timestamp onwards
collapse: (string) for some widgets, this collapses sources based on a regex
source: (string) If specified, only compile data on this specific sourceID
unique: (boolean) Only compile data from unique commits, ignore duplicates

Input examples:

application/json:
{
    "interval": "month",
    "quick": false,
    "to": 1503483273,
    "span": 2,
    "types": [
        "jira",
        "bugzilla"
    ],
    "view": "abcdef12345678",
    "distinguish": false,
    "from": 1400000000,
    "source": "abcdef12345678"
}

Response examples:

200:
{}
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}
GET
/api/code/changes
Show insertions/deletions as a timeseries

JSON parameters:


Response examples:

200:
{
    "timeseries": [
        {
            "date": 1508273,
            "$item": 50,
            "$otheritem": 26
        }
    ]
}
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}
POST
/api/code/changes
Show insertions/deletions as a timeseries

JSON parameters:

quick: (boolean) Turns on quick data for some endpoints, returning only sparse data (thus less traffic)
to: (integer) If specified, only compile data up until here
view: (string) ID Of optional view to use
sources: (boolean) for some widget, this fetches all sources
author: (boolean) Turns on author view for code results, as opposed to the default committer view
interval: (string) If fetching histograms, this specifies the interval to pack figures into. Can be day, week, month, quarter or year
subfilter: (string) Quickly defined view by sub-filtering the existing view and matching on sourceURLs
email: (string) filter sources based on an email (a person)
links: (integer) for relationship maps, this denotes the minimum link strength (no. of connections) that makes up a link.
search: (string) for some widgets, this enables sub-filtering based on searches
types: (array) If set, only return data from sources matching these types
span: (integer) For factor charts, denotes the number of months to base factors on from
distinguish: (boolean) Enables distinguishing different types of data objects, subject to the individual API endpoint
from: (integer) If specified, compile data from this timestamp onwards
collapse: (string) for some widgets, this collapses sources based on a regex
source: (string) If specified, only compile data on this specific sourceID
unique: (boolean) Only compile data from unique commits, ignore duplicates

Input examples:

application/json:
{
    "interval": "month",
    "quick": false,
    "to": 1503483273,
    "span": 2,
    "types": [
        "jira",
        "bugzilla"
    ],
    "view": "abcdef12345678",
    "distinguish": false,
    "from": 1400000000,
    "source": "abcdef12345678"
}

Response examples:

200:
{
    "timeseries": [
        {
            "date": 1508273,
            "$item": 50,
            "$otheritem": 26
        }
    ]
}
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}
GET
/api/code/commits
Show commits as a timeseries

JSON parameters:


Response examples:

200:
{
    "timeseries": [
        {
            "date": 1508273,
            "$item": 50,
            "$otheritem": 26
        }
    ]
}
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}
POST
/api/code/commits
Show commits as a timeseries

JSON parameters:

quick: (boolean) Turns on quick data for some endpoints, returning only sparse data (thus less traffic)
to: (integer) If specified, only compile data up until here
view: (string) ID Of optional view to use
sources: (boolean) for some widget, this fetches all sources
author: (boolean) Turns on author view for code results, as opposed to the default committer view
interval: (string) If fetching histograms, this specifies the interval to pack figures into. Can be day, week, month, quarter or year
subfilter: (string) Quickly defined view by sub-filtering the existing view and matching on sourceURLs
email: (string) filter sources based on an email (a person)
links: (integer) for relationship maps, this denotes the minimum link strength (no. of connections) that makes up a link.
search: (string) for some widgets, this enables sub-filtering based on searches
types: (array) If set, only return data from sources matching these types
span: (integer) For factor charts, denotes the number of months to base factors on from
distinguish: (boolean) Enables distinguishing different types of data objects, subject to the individual API endpoint
from: (integer) If specified, compile data from this timestamp onwards
collapse: (string) for some widgets, this collapses sources based on a regex
source: (string) If specified, only compile data on this specific sourceID
unique: (boolean) Only compile data from unique commits, ignore duplicates

Input examples:

application/json:
{
    "interval": "month",
    "quick": false,
    "to": 1503483273,
    "span": 2,
    "types": [
        "jira",
        "bugzilla"
    ],
    "view": "abcdef12345678",
    "distinguish": false,
    "from": 1400000000,
    "source": "abcdef12345678"
}

Response examples:

200:
{
    "timeseries": [
        {
            "date": 1508273,
            "$item": 50,
            "$otheritem": 26
        }
    ]
}
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}
GET
/api/code/committers
Shows the top N of committers

JSON parameters:


Response examples:

200:
{}
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}
POST
/api/code/committers
Shows trend data for a set of repos over a given period of time

JSON parameters:

quick: (boolean) Turns on quick data for some endpoints, returning only sparse data (thus less traffic)
to: (integer) If specified, only compile data up until here
view: (string) ID Of optional view to use
sources: (boolean) for some widget, this fetches all sources
author: (boolean) Turns on author view for code results, as opposed to the default committer view
interval: (string) If fetching histograms, this specifies the interval to pack figures into. Can be day, week, month, quarter or year
subfilter: (string) Quickly defined view by sub-filtering the existing view and matching on sourceURLs
email: (string) filter sources based on an email (a person)
links: (integer) for relationship maps, this denotes the minimum link strength (no. of connections) that makes up a link.
search: (string) for some widgets, this enables sub-filtering based on searches
types: (array) If set, only return data from sources matching these types
span: (integer) For factor charts, denotes the number of months to base factors on from
distinguish: (boolean) Enables distinguishing different types of data objects, subject to the individual API endpoint
from: (integer) If specified, compile data from this timestamp onwards
collapse: (string) for some widgets, this collapses sources based on a regex
source: (string) If specified, only compile data on this specific sourceID
unique: (boolean) Only compile data from unique commits, ignore duplicates

Input examples:

application/json:
{
    "interval": "month",
    "quick": false,
    "to": 1503483273,
    "span": 2,
    "types": [
        "jira",
        "bugzilla"
    ],
    "view": "abcdef12345678",
    "distinguish": false,
    "from": 1400000000,
    "source": "abcdef12345678"
}

Response examples:

200:
{}
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}
GET
/api/code/evolution
Show code evolution as a timeseries

JSON parameters:


Response examples:

200:
{
    "timeseries": [
        {
            "date": 1508273,
            "$item": 50,
            "$otheritem": 26
        }
    ]
}
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}
POST
/api/code/evolution
Show code evolution as a timeseries

JSON parameters:

quick: (boolean) Turns on quick data for some endpoints, returning only sparse data (thus less traffic)
to: (integer) If specified, only compile data up until here
view: (string) ID Of optional view to use
sources: (boolean) for some widget, this fetches all sources
author: (boolean) Turns on author view for code results, as opposed to the default committer view
interval: (string) If fetching histograms, this specifies the interval to pack figures into. Can be day, week, month, quarter or year
subfilter: (string) Quickly defined view by sub-filtering the existing view and matching on sourceURLs
email: (string) filter sources based on an email (a person)
links: (integer) for relationship maps, this denotes the minimum link strength (no. of connections) that makes up a link.
search: (string) for some widgets, this enables sub-filtering based on searches
types: (array) If set, only return data from sources matching these types
span: (integer) For factor charts, denotes the number of months to base factors on from
distinguish: (boolean) Enables distinguishing different types of data objects, subject to the individual API endpoint
from: (integer) If specified, compile data from this timestamp onwards
collapse: (string) for some widgets, this collapses sources based on a regex
source: (string) If specified, only compile data on this specific sourceID
unique: (boolean) Only compile data from unique commits, ignore duplicates

Input examples:

application/json:
{
    "interval": "month",
    "quick": false,
    "to": 1503483273,
    "span": 2,
    "types": [
        "jira",
        "bugzilla"
    ],
    "view": "abcdef12345678",
    "distinguish": false,
    "from": 1400000000,
    "source": "abcdef12345678"
}

Response examples:

200:
{
    "timeseries": [
        {
            "date": 1508273,
            "$item": 50,
            "$otheritem": 26
        }
    ]
}
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}
GET
/api/code/pony
Shows pony factor data for a set of repos over a given period of time

JSON parameters:


Response examples:

200:
{
    "factors": [
        {}
    ]
}
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}
POST
/api/code/pony
Shows pony factor data for a set of repos over a given period of time

JSON parameters:

quick: (boolean) Turns on quick data for some endpoints, returning only sparse data (thus less traffic)
to: (integer) If specified, only compile data up until here
view: (string) ID Of optional view to use
sources: (boolean) for some widget, this fetches all sources
author: (boolean) Turns on author view for code results, as opposed to the default committer view
interval: (string) If fetching histograms, this specifies the interval to pack figures into. Can be day, week, month, quarter or year
subfilter: (string) Quickly defined view by sub-filtering the existing view and matching on sourceURLs
email: (string) filter sources based on an email (a person)
links: (integer) for relationship maps, this denotes the minimum link strength (no. of connections) that makes up a link.
search: (string) for some widgets, this enables sub-filtering based on searches
types: (array) If set, only return data from sources matching these types
span: (integer) For factor charts, denotes the number of months to base factors on from
distinguish: (boolean) Enables distinguishing different types of data objects, subject to the individual API endpoint
from: (integer) If specified, compile data from this timestamp onwards
collapse: (string) for some widgets, this collapses sources based on a regex
source: (string) If specified, only compile data on this specific sourceID
unique: (boolean) Only compile data from unique commits, ignore duplicates

Input examples:

application/json:
{
    "interval": "month",
    "quick": false,
    "to": 1503483273,
    "span": 2,
    "types": [
        "jira",
        "bugzilla"
    ],
    "view": "abcdef12345678",
    "distinguish": false,
    "from": 1400000000,
    "source": "abcdef12345678"
}

Response examples:

200:
{
    "factors": [
        {}
    ]
}
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}
GET
/api/code/pony-timeseries
Shows timeseries of Pony Factor over time

JSON parameters:


Response examples:

200:
{
    "timeseries": [
        {
            "date": 1508273,
            "$item": 50,
            "$otheritem": 26
        }
    ]
}
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}
POST
/api/code/pony-timeseries
Shows timeseries of Pony Factor over time

JSON parameters:

quick: (boolean) Turns on quick data for some endpoints, returning only sparse data (thus less traffic)
to: (integer) If specified, only compile data up until here
view: (string) ID Of optional view to use
sources: (boolean) for some widget, this fetches all sources
author: (boolean) Turns on author view for code results, as opposed to the default committer view
interval: (string) If fetching histograms, this specifies the interval to pack figures into. Can be day, week, month, quarter or year
subfilter: (string) Quickly defined view by sub-filtering the existing view and matching on sourceURLs
email: (string) filter sources based on an email (a person)
links: (integer) for relationship maps, this denotes the minimum link strength (no. of connections) that makes up a link.
search: (string) for some widgets, this enables sub-filtering based on searches
types: (array) If set, only return data from sources matching these types
span: (integer) For factor charts, denotes the number of months to base factors on from
distinguish: (boolean) Enables distinguishing different types of data objects, subject to the individual API endpoint
from: (integer) If specified, compile data from this timestamp onwards
collapse: (string) for some widgets, this collapses sources based on a regex
source: (string) If specified, only compile data on this specific sourceID
unique: (boolean) Only compile data from unique commits, ignore duplicates

Input examples:

application/json:
{
    "interval": "month",
    "quick": false,
    "to": 1503483273,
    "span": 2,
    "types": [
        "jira",
        "bugzilla"
    ],
    "view": "abcdef12345678",
    "distinguish": false,
    "from": 1400000000,
    "source": "abcdef12345678"
}

Response examples:

200:
{
    "timeseries": [
        {
            "date": 1508273,
            "$item": 50,
            "$otheritem": 26
        }
    ]
}
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}
GET
/api/code/relationships
Shows a breakdown of contributor relationships between repositories

JSON parameters:


Response examples:

200:
{}
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}
POST
/api/code/relationships
Shows a breakdown of contributor relationships between repositories

JSON parameters:

quick: (boolean) Turns on quick data for some endpoints, returning only sparse data (thus less traffic)
to: (integer) If specified, only compile data up until here
view: (string) ID Of optional view to use
sources: (boolean) for some widget, this fetches all sources
author: (boolean) Turns on author view for code results, as opposed to the default committer view
interval: (string) If fetching histograms, this specifies the interval to pack figures into. Can be day, week, month, quarter or year
subfilter: (string) Quickly defined view by sub-filtering the existing view and matching on sourceURLs
email: (string) filter sources based on an email (a person)
links: (integer) for relationship maps, this denotes the minimum link strength (no. of connections) that makes up a link.
search: (string) for some widgets, this enables sub-filtering based on searches
types: (array) If set, only return data from sources matching these types
span: (integer) For factor charts, denotes the number of months to base factors on from
distinguish: (boolean) Enables distinguishing different types of data objects, subject to the individual API endpoint
from: (integer) If specified, compile data from this timestamp onwards
collapse: (string) for some widgets, this collapses sources based on a regex
source: (string) If specified, only compile data on this specific sourceID
unique: (boolean) Only compile data from unique commits, ignore duplicates

Input examples:

application/json:
{
    "interval": "month",
    "quick": false,
    "to": 1503483273,
    "span": 2,
    "types": [
        "jira",
        "bugzilla"
    ],
    "view": "abcdef12345678",
    "distinguish": false,
    "from": 1400000000,
    "source": "abcdef12345678"
}

Response examples:

200:
{}
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}
GET
/api/code/retention
Shows retention metrics for a set of repos over a given period of time

JSON parameters:


Response examples:

200:
{
    "factors": [
        {}
    ]
}
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}
POST
/api/code/retention
Shows retention metrics for a set of repos over a given period of time

JSON parameters:

quick: (boolean) Turns on quick data for some endpoints, returning only sparse data (thus less traffic)
to: (integer) If specified, only compile data up until here
view: (string) ID Of optional view to use
sources: (boolean) for some widget, this fetches all sources
author: (boolean) Turns on author view for code results, as opposed to the default committer view
interval: (string) If fetching histograms, this specifies the interval to pack figures into. Can be day, week, month, quarter or year
subfilter: (string) Quickly defined view by sub-filtering the existing view and matching on sourceURLs
email: (string) filter sources based on an email (a person)
links: (integer) for relationship maps, this denotes the minimum link strength (no. of connections) that makes up a link.
search: (string) for some widgets, this enables sub-filtering based on searches
types: (array) If set, only return data from sources matching these types
span: (integer) For factor charts, denotes the number of months to base factors on from
distinguish: (boolean) Enables distinguishing different types of data objects, subject to the individual API endpoint
from: (integer) If specified, compile data from this timestamp onwards
collapse: (string) for some widgets, this collapses sources based on a regex
source: (string) If specified, only compile data on this specific sourceID
unique: (boolean) Only compile data from unique commits, ignore duplicates

Input examples:

application/json:
{
    "interval": "month",
    "quick": false,
    "to": 1503483273,
    "span": 2,
    "types": [
        "jira",
        "bugzilla"
    ],
    "view": "abcdef12345678",
    "distinguish": false,
    "from": 1400000000,
    "source": "abcdef12345678"
}

Response examples:

200:
{
    "factors": [
        {}
    ]
}
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}
GET
/api/code/sloc
Shows a breakdown of lines of code for one or more sources

JSON parameters:


Response examples:

200:
{}
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}
POST
/api/code/sloc
Shows a breakdown of lines of code for one or more sources

JSON parameters:

quick: (boolean) Turns on quick data for some endpoints, returning only sparse data (thus less traffic)
to: (integer) If specified, only compile data up until here
view: (string) ID Of optional view to use
sources: (boolean) for some widget, this fetches all sources
author: (boolean) Turns on author view for code results, as opposed to the default committer view
interval: (string) If fetching histograms, this specifies the interval to pack figures into. Can be day, week, month, quarter or year
subfilter: (string) Quickly defined view by sub-filtering the existing view and matching on sourceURLs
email: (string) filter sources based on an email (a person)
links: (integer) for relationship maps, this denotes the minimum link strength (no. of connections) that makes up a link.
search: (string) for some widgets, this enables sub-filtering based on searches
types: (array) If set, only return data from sources matching these types
span: (integer) For factor charts, denotes the number of months to base factors on from
distinguish: (boolean) Enables distinguishing different types of data objects, subject to the individual API endpoint
from: (integer) If specified, compile data from this timestamp onwards
collapse: (string) for some widgets, this collapses sources based on a regex
source: (string) If specified, only compile data on this specific sourceID
unique: (boolean) Only compile data from unique commits, ignore duplicates

Input examples:

application/json:
{
    "interval": "month",
    "quick": false,
    "to": 1503483273,
    "span": 2,
    "types": [
        "jira",
        "bugzilla"
    ],
    "view": "abcdef12345678",
    "distinguish": false,
    "from": 1400000000,
    "source": "abcdef12345678"
}

Response examples:

200:
{}
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}
GET
/api/code/top-commits
Shows top 25 repos by commit volume

JSON parameters:


Response examples:

200:
{
    "timeseries": [
        {
            "date": 1508273,
            "$item": 50,
            "$otheritem": 26
        }
    ]
}
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}
POST
/api/code/top-commits
Shows top 25 repos by commit volume

JSON parameters:

quick: (boolean) Turns on quick data for some endpoints, returning only sparse data (thus less traffic)
to: (integer) If specified, only compile data up until here
view: (string) ID Of optional view to use
sources: (boolean) for some widget, this fetches all sources
author: (boolean) Turns on author view for code results, as opposed to the default committer view
interval: (string) If fetching histograms, this specifies the interval to pack figures into. Can be day, week, month, quarter or year
subfilter: (string) Quickly defined view by sub-filtering the existing view and matching on sourceURLs
email: (string) filter sources based on an email (a person)
links: (integer) for relationship maps, this denotes the minimum link strength (no. of connections) that makes up a link.
search: (string) for some widgets, this enables sub-filtering based on searches
types: (array) If set, only return data from sources matching these types
span: (integer) For factor charts, denotes the number of months to base factors on from
distinguish: (boolean) Enables distinguishing different types of data objects, subject to the individual API endpoint
from: (integer) If specified, compile data from this timestamp onwards
collapse: (string) for some widgets, this collapses sources based on a regex
source: (string) If specified, only compile data on this specific sourceID
unique: (boolean) Only compile data from unique commits, ignore duplicates

Input examples:

application/json:
{
    "interval": "month",
    "quick": false,
    "to": 1503483273,
    "span": 2,
    "types": [
        "jira",
        "bugzilla"
    ],
    "view": "abcdef12345678",
    "distinguish": false,
    "from": 1400000000,
    "source": "abcdef12345678"
}

Response examples:

200:
{
    "timeseries": [
        {
            "date": 1508273,
            "$item": 50,
            "$otheritem": 26
        }
    ]
}
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}
GET
/api/code/top-sloc
Shows top 25 repos by lines of code

JSON parameters:


Response examples:

200:
{
    "timeseries": [
        {
            "date": 1508273,
            "$item": 50,
            "$otheritem": 26
        }
    ]
}
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}
POST
/api/code/top-sloc
Shows top 25 repos by lines of code

JSON parameters:

quick: (boolean) Turns on quick data for some endpoints, returning only sparse data (thus less traffic)
to: (integer) If specified, only compile data up until here
view: (string) ID Of optional view to use
sources: (boolean) for some widget, this fetches all sources
author: (boolean) Turns on author view for code results, as opposed to the default committer view
interval: (string) If fetching histograms, this specifies the interval to pack figures into. Can be day, week, month, quarter or year
subfilter: (string) Quickly defined view by sub-filtering the existing view and matching on sourceURLs
email: (string) filter sources based on an email (a person)
links: (integer) for relationship maps, this denotes the minimum link strength (no. of connections) that makes up a link.
search: (string) for some widgets, this enables sub-filtering based on searches
types: (array) If set, only return data from sources matching these types
span: (integer) For factor charts, denotes the number of months to base factors on from
distinguish: (boolean) Enables distinguishing different types of data objects, subject to the individual API endpoint
from: (integer) If specified, compile data from this timestamp onwards
collapse: (string) for some widgets, this collapses sources based on a regex
source: (string) If specified, only compile data on this specific sourceID
unique: (boolean) Only compile data from unique commits, ignore duplicates

Input examples:

application/json:
{
    "interval": "month",
    "quick": false,
    "to": 1503483273,
    "span": 2,
    "types": [
        "jira",
        "bugzilla"
    ],
    "view": "abcdef12345678",
    "distinguish": false,
    "from": 1400000000,
    "source": "abcdef12345678"
}

Response examples:

200:
{
    "timeseries": [
        {
            "date": 1508273,
            "$item": 50,
            "$otheritem": 26
        }
    ]
}
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}
POST
/api/code/trends
Shows trend data for a set of repos over a given period of time

JSON parameters:

quick: (boolean) Turns on quick data for some endpoints, returning only sparse data (thus less traffic)
to: (integer) If specified, only compile data up until here
view: (string) ID Of optional view to use
sources: (boolean) for some widget, this fetches all sources
author: (boolean) Turns on author view for code results, as opposed to the default committer view
interval: (string) If fetching histograms, this specifies the interval to pack figures into. Can be day, week, month, quarter or year
subfilter: (string) Quickly defined view by sub-filtering the existing view and matching on sourceURLs
email: (string) filter sources based on an email (a person)
links: (integer) for relationship maps, this denotes the minimum link strength (no. of connections) that makes up a link.
search: (string) for some widgets, this enables sub-filtering based on searches
types: (array) If set, only return data from sources matching these types
span: (integer) For factor charts, denotes the number of months to base factors on from
distinguish: (boolean) Enables distinguishing different types of data objects, subject to the individual API endpoint
from: (integer) If specified, compile data from this timestamp onwards
collapse: (string) for some widgets, this collapses sources based on a regex
source: (string) If specified, only compile data on this specific sourceID
unique: (boolean) Only compile data from unique commits, ignore duplicates

Input examples:

application/json:
{
    "interval": "month",
    "quick": false,
    "to": 1503483273,
    "span": 2,
    "types": [
        "jira",
        "bugzilla"
    ],
    "view": "abcdef12345678",
    "distinguish": false,
    "from": 1400000000,
    "source": "abcdef12345678"
}

Response examples:

200:
{}
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}
GET
/api/issue/actors
Shows timeseries of no. of people opening/closing issues over time

JSON parameters:


Response examples:

200:
{
    "timeseries": [
        {
            "date": 1508273,
            "$item": 50,
            "$otheritem": 26
        }
    ]
}
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}
POST
/api/issue/actors
Shows timeseries of no. of people opening/closing issues over time

JSON parameters:

quick: (boolean) Turns on quick data for some endpoints, returning only sparse data (thus less traffic)
to: (integer) If specified, only compile data up until here
view: (string) ID Of optional view to use
sources: (boolean) for some widget, this fetches all sources
author: (boolean) Turns on author view for code results, as opposed to the default committer view
interval: (string) If fetching histograms, this specifies the interval to pack figures into. Can be day, week, month, quarter or year
subfilter: (string) Quickly defined view by sub-filtering the existing view and matching on sourceURLs
email: (string) filter sources based on an email (a person)
links: (integer) for relationship maps, this denotes the minimum link strength (no. of connections) that makes up a link.
search: (string) for some widgets, this enables sub-filtering based on searches
types: (array) If set, only return data from sources matching these types
span: (integer) For factor charts, denotes the number of months to base factors on from
distinguish: (boolean) Enables distinguishing different types of data objects, subject to the individual API endpoint
from: (integer) If specified, compile data from this timestamp onwards
collapse: (string) for some widgets, this collapses sources based on a regex
source: (string) If specified, only compile data on this specific sourceID
unique: (boolean) Only compile data from unique commits, ignore duplicates

Input examples:

application/json:
{
    "interval": "month",
    "quick": false,
    "to": 1503483273,
    "span": 2,
    "types": [
        "jira",
        "bugzilla"
    ],
    "view": "abcdef12345678",
    "distinguish": false,
    "from": 1400000000,
    "source": "abcdef12345678"
}

Response examples:

200:
{
    "timeseries": [
        {
            "date": 1508273,
            "$item": 50,
            "$otheritem": 26
        }
    ]
}
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}
GET
/api/issue/age
Shows timeseries of no. of open tickets by age

JSON parameters:


Response examples:

200:
{
    "timeseries": [
        {
            "date": 1508273,
            "$item": 50,
            "$otheritem": 26
        }
    ]
}
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}
POST
/api/issue/age
Shows timeseries of no. of open tickets by age

JSON parameters:

quick: (boolean) Turns on quick data for some endpoints, returning only sparse data (thus less traffic)
to: (integer) If specified, only compile data up until here
view: (string) ID Of optional view to use
sources: (boolean) for some widget, this fetches all sources
author: (boolean) Turns on author view for code results, as opposed to the default committer view
interval: (string) If fetching histograms, this specifies the interval to pack figures into. Can be day, week, month, quarter or year
subfilter: (string) Quickly defined view by sub-filtering the existing view and matching on sourceURLs
email: (string) filter sources based on an email (a person)
links: (integer) for relationship maps, this denotes the minimum link strength (no. of connections) that makes up a link.
search: (string) for some widgets, this enables sub-filtering based on searches
types: (array) If set, only return data from sources matching these types
span: (integer) For factor charts, denotes the number of months to base factors on from
distinguish: (boolean) Enables distinguishing different types of data objects, subject to the individual API endpoint
from: (integer) If specified, compile data from this timestamp onwards
collapse: (string) for some widgets, this collapses sources based on a regex
source: (string) If specified, only compile data on this specific sourceID
unique: (boolean) Only compile data from unique commits, ignore duplicates

Input examples:

application/json:
{
    "interval": "month",
    "quick": false,
    "to": 1503483273,
    "span": 2,
    "types": [
        "jira",
        "bugzilla"
    ],
    "view": "abcdef12345678",
    "distinguish": false,
    "from": 1400000000,
    "source": "abcdef12345678"
}

Response examples:

200:
{
    "timeseries": [
        {
            "date": 1508273,
            "$item": 50,
            "$otheritem": 26
        }
    ]
}
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}
GET
/api/issue/closers
Shows the top N of issue closers

JSON parameters:


Response examples:

200:
{}
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}
POST
/api/issue/closers
Shows the top N of issue closers

JSON parameters:

quick: (boolean) Turns on quick data for some endpoints, returning only sparse data (thus less traffic)
to: (integer) If specified, only compile data up until here
view: (string) ID Of optional view to use
sources: (boolean) for some widget, this fetches all sources
author: (boolean) Turns on author view for code results, as opposed to the default committer view
interval: (string) If fetching histograms, this specifies the interval to pack figures into. Can be day, week, month, quarter or year
subfilter: (string) Quickly defined view by sub-filtering the existing view and matching on sourceURLs
email: (string) filter sources based on an email (a person)
links: (integer) for relationship maps, this denotes the minimum link strength (no. of connections) that makes up a link.
search: (string) for some widgets, this enables sub-filtering based on searches
types: (array) If set, only return data from sources matching these types
span: (integer) For factor charts, denotes the number of months to base factors on from
distinguish: (boolean) Enables distinguishing different types of data objects, subject to the individual API endpoint
from: (integer) If specified, compile data from this timestamp onwards
collapse: (string) for some widgets, this collapses sources based on a regex
source: (string) If specified, only compile data on this specific sourceID
unique: (boolean) Only compile data from unique commits, ignore duplicates

Input examples:

application/json:
{
    "interval": "month",
    "quick": false,
    "to": 1503483273,
    "span": 2,
    "types": [
        "jira",
        "bugzilla"
    ],
    "view": "abcdef12345678",
    "distinguish": false,
    "from": 1400000000,
    "source": "abcdef12345678"
}

Response examples:

200:
{}
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}
GET
/api/issue/issues
Shows timeseries of issues opened/closed over time

JSON parameters:


Response examples:

200:
{
    "timeseries": [
        {
            "date": 1508273,
            "$item": 50,
            "$otheritem": 26
        }
    ]
}
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}
POST
/api/issue/issues
Shows timeseries of issues opened/closed over time

JSON parameters:

quick: (boolean) Turns on quick data for some endpoints, returning only sparse data (thus less traffic)
to: (integer) If specified, only compile data up until here
view: (string) ID Of optional view to use
sources: (boolean) for some widget, this fetches all sources
author: (boolean) Turns on author view for code results, as opposed to the default committer view
interval: (string) If fetching histograms, this specifies the interval to pack figures into. Can be day, week, month, quarter or year
subfilter: (string) Quickly defined view by sub-filtering the existing view and matching on sourceURLs
email: (string) filter sources based on an email (a person)
links: (integer) for relationship maps, this denotes the minimum link strength (no. of connections) that makes up a link.
search: (string) for some widgets, this enables sub-filtering based on searches
types: (array) If set, only return data from sources matching these types
span: (integer) For factor charts, denotes the number of months to base factors on from
distinguish: (boolean) Enables distinguishing different types of data objects, subject to the individual API endpoint
from: (integer) If specified, compile data from this timestamp onwards
collapse: (string) for some widgets, this collapses sources based on a regex
source: (string) If specified, only compile data on this specific sourceID
unique: (boolean) Only compile data from unique commits, ignore duplicates

Input examples:

application/json:
{
    "interval": "month",
    "quick": false,
    "to": 1503483273,
    "span": 2,
    "types": [
        "jira",
        "bugzilla"
    ],
    "view": "abcdef12345678",
    "distinguish": false,
    "from": 1400000000,
    "source": "abcdef12345678"
}

Response examples:

200:
{
    "timeseries": [
        {
            "date": 1508273,
            "$item": 50,
            "$otheritem": 26
        }
    ]
}
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}
GET
/api/issue/openers
Shows the top N of issue openers

JSON parameters:


Response examples:

200:
{}
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}
POST
/api/issue/openers
Shows the top N of issue openers

JSON parameters:

quick: (boolean) Turns on quick data for some endpoints, returning only sparse data (thus less traffic)
to: (integer) If specified, only compile data up until here
view: (string) ID Of optional view to use
sources: (boolean) for some widget, this fetches all sources
author: (boolean) Turns on author view for code results, as opposed to the default committer view
interval: (string) If fetching histograms, this specifies the interval to pack figures into. Can be day, week, month, quarter or year
subfilter: (string) Quickly defined view by sub-filtering the existing view and matching on sourceURLs
email: (string) filter sources based on an email (a person)
links: (integer) for relationship maps, this denotes the minimum link strength (no. of connections) that makes up a link.
search: (string) for some widgets, this enables sub-filtering based on searches
types: (array) If set, only return data from sources matching these types
span: (integer) For factor charts, denotes the number of months to base factors on from
distinguish: (boolean) Enables distinguishing different types of data objects, subject to the individual API endpoint
from: (integer) If specified, compile data from this timestamp onwards
collapse: (string) for some widgets, this collapses sources based on a regex
source: (string) If specified, only compile data on this specific sourceID
unique: (boolean) Only compile data from unique commits, ignore duplicates

Input examples:

application/json:
{
    "interval": "month",
    "quick": false,
    "to": 1503483273,
    "span": 2,
    "types": [
        "jira",
        "bugzilla"
    ],
    "view": "abcdef12345678",
    "distinguish": false,
    "from": 1400000000,
    "source": "abcdef12345678"
}

Response examples:

200:
{}
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}
GET
/api/issue/pony-timeseries
Shows timeseries of Pony Factor over time

JSON parameters:


Response examples:

200:
{
    "timeseries": [
        {
            "date": 1508273,
            "$item": 50,
            "$otheritem": 26
        }
    ]
}
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}
POST
/api/issue/pony-timeseries
Shows timeseries of Pony Factor over time

JSON parameters:

quick: (boolean) Turns on quick data for some endpoints, returning only sparse data (thus less traffic)
to: (integer) If specified, only compile data up until here
view: (string) ID Of optional view to use
sources: (boolean) for some widget, this fetches all sources
author: (boolean) Turns on author view for code results, as opposed to the default committer view
interval: (string) If fetching histograms, this specifies the interval to pack figures into. Can be day, week, month, quarter or year
subfilter: (string) Quickly defined view by sub-filtering the existing view and matching on sourceURLs
email: (string) filter sources based on an email (a person)
links: (integer) for relationship maps, this denotes the minimum link strength (no. of connections) that makes up a link.
search: (string) for some widgets, this enables sub-filtering based on searches
types: (array) If set, only return data from sources matching these types
span: (integer) For factor charts, denotes the number of months to base factors on from
distinguish: (boolean) Enables distinguishing different types of data objects, subject to the individual API endpoint
from: (integer) If specified, compile data from this timestamp onwards
collapse: (string) for some widgets, this collapses sources based on a regex
source: (string) If specified, only compile data on this specific sourceID
unique: (boolean) Only compile data from unique commits, ignore duplicates

Input examples:

application/json:
{
    "interval": "month",
    "quick": false,
    "to": 1503483273,
    "span": 2,
    "types": [
        "jira",
        "bugzilla"
    ],
    "view": "abcdef12345678",
    "distinguish": false,
    "from": 1400000000,
    "source": "abcdef12345678"
}

Response examples:

200:
{
    "timeseries": [
        {
            "date": 1508273,
            "$item": 50,
            "$otheritem": 26
        }
    ]
}
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}
GET
/api/issue/relationships
Shows a breakdown of contributor relationships between issue trackers

JSON parameters:


Response examples:

200:
{}
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}
POST
/api/issue/relationships
Shows a breakdown of contributor relationships between issue trackers

JSON parameters:

quick: (boolean) Turns on quick data for some endpoints, returning only sparse data (thus less traffic)
to: (integer) If specified, only compile data up until here
view: (string) ID Of optional view to use
sources: (boolean) for some widget, this fetches all sources
author: (boolean) Turns on author view for code results, as opposed to the default committer view
interval: (string) If fetching histograms, this specifies the interval to pack figures into. Can be day, week, month, quarter or year
subfilter: (string) Quickly defined view by sub-filtering the existing view and matching on sourceURLs
email: (string) filter sources based on an email (a person)
links: (integer) for relationship maps, this denotes the minimum link strength (no. of connections) that makes up a link.
search: (string) for some widgets, this enables sub-filtering based on searches
types: (array) If set, only return data from sources matching these types
span: (integer) For factor charts, denotes the number of months to base factors on from
distinguish: (boolean) Enables distinguishing different types of data objects, subject to the individual API endpoint
from: (integer) If specified, compile data from this timestamp onwards
collapse: (string) for some widgets, this collapses sources based on a regex
source: (string) If specified, only compile data on this specific sourceID
unique: (boolean) Only compile data from unique commits, ignore duplicates

Input examples:

application/json:
{
    "interval": "month",
    "quick": false,
    "to": 1503483273,
    "span": 2,
    "types": [
        "jira",
        "bugzilla"
    ],
    "view": "abcdef12345678",
    "distinguish": false,
    "from": 1400000000,
    "source": "abcdef12345678"
}

Response examples:

200:
{}
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}
GET
/api/issue/retention
Shows retention metrics for a set of issue trackers over a given period of time

JSON parameters:


Response examples:

200:
{
    "factors": [
        {}
    ]
}
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}
POST
/api/issue/retention
Shows retention metrics for a set of issue trackers over a given period of time

JSON parameters:

quick: (boolean) Turns on quick data for some endpoints, returning only sparse data (thus less traffic)
to: (integer) If specified, only compile data up until here
view: (string) ID Of optional view to use
sources: (boolean) for some widget, this fetches all sources
author: (boolean) Turns on author view for code results, as opposed to the default committer view
interval: (string) If fetching histograms, this specifies the interval to pack figures into. Can be day, week, month, quarter or year
subfilter: (string) Quickly defined view by sub-filtering the existing view and matching on sourceURLs
email: (string) filter sources based on an email (a person)
links: (integer) for relationship maps, this denotes the minimum link strength (no. of connections) that makes up a link.
search: (string) for some widgets, this enables sub-filtering based on searches
types: (array) If set, only return data from sources matching these types
span: (integer) For factor charts, denotes the number of months to base factors on from
distinguish: (boolean) Enables distinguishing different types of data objects, subject to the individual API endpoint
from: (integer) If specified, compile data from this timestamp onwards
collapse: (string) for some widgets, this collapses sources based on a regex
source: (string) If specified, only compile data on this specific sourceID
unique: (boolean) Only compile data from unique commits, ignore duplicates

Input examples:

application/json:
{
    "interval": "month",
    "quick": false,
    "to": 1503483273,
    "span": 2,
    "types": [
        "jira",
        "bugzilla"
    ],
    "view": "abcdef12345678",
    "distinguish": false,
    "from": 1400000000,
    "source": "abcdef12345678"
}

Response examples:

200:
{
    "factors": [
        {}
    ]
}
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}
GET
/api/issue/top
Shows the top N issues by interactions

JSON parameters:


Response examples:

200:
{
    "top": [
        {}
    ]
}
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}
POST
/api/issue/top
Shows the top N issues by interactions

JSON parameters:

quick: (boolean) Turns on quick data for some endpoints, returning only sparse data (thus less traffic)
to: (integer) If specified, only compile data up until here
view: (string) ID Of optional view to use
sources: (boolean) for some widget, this fetches all sources
author: (boolean) Turns on author view for code results, as opposed to the default committer view
interval: (string) If fetching histograms, this specifies the interval to pack figures into. Can be day, week, month, quarter or year
subfilter: (string) Quickly defined view by sub-filtering the existing view and matching on sourceURLs
email: (string) filter sources based on an email (a person)
links: (integer) for relationship maps, this denotes the minimum link strength (no. of connections) that makes up a link.
search: (string) for some widgets, this enables sub-filtering based on searches
types: (array) If set, only return data from sources matching these types
span: (integer) For factor charts, denotes the number of months to base factors on from
distinguish: (boolean) Enables distinguishing different types of data objects, subject to the individual API endpoint
from: (integer) If specified, compile data from this timestamp onwards
collapse: (string) for some widgets, this collapses sources based on a regex
source: (string) If specified, only compile data on this specific sourceID
unique: (boolean) Only compile data from unique commits, ignore duplicates

Input examples:

application/json:
{
    "interval": "month",
    "quick": false,
    "to": 1503483273,
    "span": 2,
    "types": [
        "jira",
        "bugzilla"
    ],
    "view": "abcdef12345678",
    "distinguish": false,
    "from": 1400000000,
    "source": "abcdef12345678"
}

Response examples:

200:
{
    "top": [
        {}
    ]
}
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}
GET
/api/issue/top-count
Shows top 25 issue trackers by issues

JSON parameters:


Response examples:

200:
{
    "timeseries": [
        {
            "date": 1508273,
            "$item": 50,
            "$otheritem": 26
        }
    ]
}
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}
POST
/api/issue/top-count
Shows top 25 issue trackers by issues

JSON parameters:

quick: (boolean) Turns on quick data for some endpoints, returning only sparse data (thus less traffic)
to: (integer) If specified, only compile data up until here
view: (string) ID Of optional view to use
sources: (boolean) for some widget, this fetches all sources
author: (boolean) Turns on author view for code results, as opposed to the default committer view
interval: (string) If fetching histograms, this specifies the interval to pack figures into. Can be day, week, month, quarter or year
subfilter: (string) Quickly defined view by sub-filtering the existing view and matching on sourceURLs
email: (string) filter sources based on an email (a person)
links: (integer) for relationship maps, this denotes the minimum link strength (no. of connections) that makes up a link.
search: (string) for some widgets, this enables sub-filtering based on searches
types: (array) If set, only return data from sources matching these types
span: (integer) For factor charts, denotes the number of months to base factors on from
distinguish: (boolean) Enables distinguishing different types of data objects, subject to the individual API endpoint
from: (integer) If specified, compile data from this timestamp onwards
collapse: (string) for some widgets, this collapses sources based on a regex
source: (string) If specified, only compile data on this specific sourceID
unique: (boolean) Only compile data from unique commits, ignore duplicates

Input examples:

application/json:
{
    "interval": "month",
    "quick": false,
    "to": 1503483273,
    "span": 2,
    "types": [
        "jira",
        "bugzilla"
    ],
    "view": "abcdef12345678",
    "distinguish": false,
    "from": 1400000000,
    "source": "abcdef12345678"
}

Response examples:

200:
{
    "timeseries": [
        {
            "date": 1508273,
            "$item": 50,
            "$otheritem": 26
        }
    ]
}
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}
POST
/api/issue/trends
Shows trend data for a set of issue trackers over a given period of time

JSON parameters:

quick: (boolean) Turns on quick data for some endpoints, returning only sparse data (thus less traffic)
to: (integer) If specified, only compile data up until here
view: (string) ID Of optional view to use
sources: (boolean) for some widget, this fetches all sources
author: (boolean) Turns on author view for code results, as opposed to the default committer view
interval: (string) If fetching histograms, this specifies the interval to pack figures into. Can be day, week, month, quarter or year
subfilter: (string) Quickly defined view by sub-filtering the existing view and matching on sourceURLs
email: (string) filter sources based on an email (a person)
links: (integer) for relationship maps, this denotes the minimum link strength (no. of connections) that makes up a link.
search: (string) for some widgets, this enables sub-filtering based on searches
types: (array) If set, only return data from sources matching these types
span: (integer) For factor charts, denotes the number of months to base factors on from
distinguish: (boolean) Enables distinguishing different types of data objects, subject to the individual API endpoint
from: (integer) If specified, compile data from this timestamp onwards
collapse: (string) for some widgets, this collapses sources based on a regex
source: (string) If specified, only compile data on this specific sourceID
unique: (boolean) Only compile data from unique commits, ignore duplicates

Input examples:

application/json:
{
    "interval": "month",
    "quick": false,
    "to": 1503483273,
    "span": 2,
    "types": [
        "jira",
        "bugzilla"
    ],
    "view": "abcdef12345678",
    "distinguish": false,
    "from": 1400000000,
    "source": "abcdef12345678"
}

Response examples:

200:
{}
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}
GET
/api/mail/map
Shows a breakdown of email author reply mappings

JSON parameters:


Response examples:

200:
{}
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}
POST
/api/mail/map
Shows a breakdown of email author reply mappings

JSON parameters:

quick: (boolean) Turns on quick data for some endpoints, returning only sparse data (thus less traffic)
to: (integer) If specified, only compile data up until here
view: (string) ID Of optional view to use
sources: (boolean) for some widget, this fetches all sources
author: (boolean) Turns on author view for code results, as opposed to the default committer view
interval: (string) If fetching histograms, this specifies the interval to pack figures into. Can be day, week, month, quarter or year
subfilter: (string) Quickly defined view by sub-filtering the existing view and matching on sourceURLs
email: (string) filter sources based on an email (a person)
links: (integer) for relationship maps, this denotes the minimum link strength (no. of connections) that makes up a link.
search: (string) for some widgets, this enables sub-filtering based on searches
types: (array) If set, only return data from sources matching these types
span: (integer) For factor charts, denotes the number of months to base factors on from
distinguish: (boolean) Enables distinguishing different types of data objects, subject to the individual API endpoint
from: (integer) If specified, compile data from this timestamp onwards
collapse: (string) for some widgets, this collapses sources based on a regex
source: (string) If specified, only compile data on this specific sourceID
unique: (boolean) Only compile data from unique commits, ignore duplicates

Input examples:

application/json:
{
    "interval": "month",
    "quick": false,
    "to": 1503483273,
    "span": 2,
    "types": [
        "jira",
        "bugzilla"
    ],
    "view": "abcdef12345678",
    "distinguish": false,
    "from": 1400000000,
    "source": "abcdef12345678"
}

Response examples:

200:
{}
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}
GET
/api/mail/pony-timeseries
Shows timeseries of Pony Factor over time

JSON parameters:


Response examples:

200:
{
    "timeseries": [
        {
            "date": 1508273,
            "$item": 50,
            "$otheritem": 26
        }
    ]
}
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}
POST
/api/mail/pony-timeseries
Shows timeseries of Pony Factor over time

JSON parameters:

quick: (boolean) Turns on quick data for some endpoints, returning only sparse data (thus less traffic)
to: (integer) If specified, only compile data up until here
view: (string) ID Of optional view to use
sources: (boolean) for some widget, this fetches all sources
author: (boolean) Turns on author view for code results, as opposed to the default committer view
interval: (string) If fetching histograms, this specifies the interval to pack figures into. Can be day, week, month, quarter or year
subfilter: (string) Quickly defined view by sub-filtering the existing view and matching on sourceURLs
email: (string) filter sources based on an email (a person)
links: (integer) for relationship maps, this denotes the minimum link strength (no. of connections) that makes up a link.
search: (string) for some widgets, this enables sub-filtering based on searches
types: (array) If set, only return data from sources matching these types
span: (integer) For factor charts, denotes the number of months to base factors on from
distinguish: (boolean) Enables distinguishing different types of data objects, subject to the individual API endpoint
from: (integer) If specified, compile data from this timestamp onwards
collapse: (string) for some widgets, this collapses sources based on a regex
source: (string) If specified, only compile data on this specific sourceID
unique: (boolean) Only compile data from unique commits, ignore duplicates

Input examples:

application/json:
{
    "interval": "month",
    "quick": false,
    "to": 1503483273,
    "span": 2,
    "types": [
        "jira",
        "bugzilla"
    ],
    "view": "abcdef12345678",
    "distinguish": false,
    "from": 1400000000,
    "source": "abcdef12345678"
}

Response examples:

200:
{
    "timeseries": [
        {
            "date": 1508273,
            "$item": 50,
            "$otheritem": 26
        }
    ]
}
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}
GET
/api/mail/relationships
Shows a breakdown of contributor relationships between mailing lists

JSON parameters:


Response examples:

200:
{}
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}
POST
/api/mail/relationships
Shows a breakdown of contributor relationships between mailing lists

JSON parameters:

quick: (boolean) Turns on quick data for some endpoints, returning only sparse data (thus less traffic)
to: (integer) If specified, only compile data up until here
view: (string) ID Of optional view to use
sources: (boolean) for some widget, this fetches all sources
author: (boolean) Turns on author view for code results, as opposed to the default committer view
interval: (string) If fetching histograms, this specifies the interval to pack figures into. Can be day, week, month, quarter or year
subfilter: (string) Quickly defined view by sub-filtering the existing view and matching on sourceURLs
email: (string) filter sources based on an email (a person)
links: (integer) for relationship maps, this denotes the minimum link strength (no. of connections) that makes up a link.
search: (string) for some widgets, this enables sub-filtering based on searches
types: (array) If set, only return data from sources matching these types
span: (integer) For factor charts, denotes the number of months to base factors on from
distinguish: (boolean) Enables distinguishing different types of data objects, subject to the individual API endpoint
from: (integer) If specified, compile data from this timestamp onwards
collapse: (string) for some widgets, this collapses sources based on a regex
source: (string) If specified, only compile data on this specific sourceID
unique: (boolean) Only compile data from unique commits, ignore duplicates

Input examples:

application/json:
{
    "interval": "month",
    "quick": false,
    "to": 1503483273,
    "span": 2,
    "types": [
        "jira",
        "bugzilla"
    ],
    "view": "abcdef12345678",
    "distinguish": false,
    "from": 1400000000,
    "source": "abcdef12345678"
}

Response examples:

200:
{}
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}
GET
/api/mail/retention
Shows retention metrics for a set of mailing lists over a given period of time

JSON parameters:


Response examples:

200:
{
    "factors": [
        {}
    ]
}
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}
POST
/api/mail/retention
Shows retention metrics for a set of mailing lists over a given period of time

JSON parameters:

quick: (boolean) Turns on quick data for some endpoints, returning only sparse data (thus less traffic)
to: (integer) If specified, only compile data up until here
view: (string) ID Of optional view to use
sources: (boolean) for some widget, this fetches all sources
author: (boolean) Turns on author view for code results, as opposed to the default committer view
interval: (string) If fetching histograms, this specifies the interval to pack figures into. Can be day, week, month, quarter or year
subfilter: (string) Quickly defined view by sub-filtering the existing view and matching on sourceURLs
email: (string) filter sources based on an email (a person)
links: (integer) for relationship maps, this denotes the minimum link strength (no. of connections) that makes up a link.
search: (string) for some widgets, this enables sub-filtering based on searches
types: (array) If set, only return data from sources matching these types
span: (integer) For factor charts, denotes the number of months to base factors on from
distinguish: (boolean) Enables distinguishing different types of data objects, subject to the individual API endpoint
from: (integer) If specified, compile data from this timestamp onwards
collapse: (string) for some widgets, this collapses sources based on a regex
source: (string) If specified, only compile data on this specific sourceID
unique: (boolean) Only compile data from unique commits, ignore duplicates

Input examples:

application/json:
{
    "interval": "month",
    "quick": false,
    "to": 1503483273,
    "span": 2,
    "types": [
        "jira",
        "bugzilla"
    ],
    "view": "abcdef12345678",
    "distinguish": false,
    "from": 1400000000,
    "source": "abcdef12345678"
}

Response examples:

200:
{
    "factors": [
        {}
    ]
}
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}
GET
/api/mail/timeseries
Shows email sent over time

JSON parameters:


Response examples:

200:
{
    "timeseries": [
        {
            "date": 1508273,
            "$item": 50,
            "$otheritem": 26
        }
    ]
}
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}
POST
/api/mail/timeseries
Shows email sent over time

JSON parameters:

quick: (boolean) Turns on quick data for some endpoints, returning only sparse data (thus less traffic)
to: (integer) If specified, only compile data up until here
view: (string) ID Of optional view to use
sources: (boolean) for some widget, this fetches all sources
author: (boolean) Turns on author view for code results, as opposed to the default committer view
interval: (string) If fetching histograms, this specifies the interval to pack figures into. Can be day, week, month, quarter or year
subfilter: (string) Quickly defined view by sub-filtering the existing view and matching on sourceURLs
email: (string) filter sources based on an email (a person)
links: (integer) for relationship maps, this denotes the minimum link strength (no. of connections) that makes up a link.
search: (string) for some widgets, this enables sub-filtering based on searches
types: (array) If set, only return data from sources matching these types
span: (integer) For factor charts, denotes the number of months to base factors on from
distinguish: (boolean) Enables distinguishing different types of data objects, subject to the individual API endpoint
from: (integer) If specified, compile data from this timestamp onwards
collapse: (string) for some widgets, this collapses sources based on a regex
source: (string) If specified, only compile data on this specific sourceID
unique: (boolean) Only compile data from unique commits, ignore duplicates

Input examples:

application/json:
{
    "interval": "month",
    "quick": false,
    "to": 1503483273,
    "span": 2,
    "types": [
        "jira",
        "bugzilla"
    ],
    "view": "abcdef12345678",
    "distinguish": false,
    "from": 1400000000,
    "source": "abcdef12345678"
}

Response examples:

200:
{
    "timeseries": [
        {
            "date": 1508273,
            "$item": 50,
            "$otheritem": 26
        }
    ]
}
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}
GET
/api/mail/timeseries-single
Shows email sent over time

JSON parameters:


Response examples:

200:
{
    "timeseries": [
        {
            "date": 1508273,
            "$item": 50,
            "$otheritem": 26
        }
    ]
}
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}
POST
/api/mail/timeseries-single
Shows email sent over time

JSON parameters:

quick: (boolean) Turns on quick data for some endpoints, returning only sparse data (thus less traffic)
to: (integer) If specified, only compile data up until here
view: (string) ID Of optional view to use
sources: (boolean) for some widget, this fetches all sources
author: (boolean) Turns on author view for code results, as opposed to the default committer view
interval: (string) If fetching histograms, this specifies the interval to pack figures into. Can be day, week, month, quarter or year
subfilter: (string) Quickly defined view by sub-filtering the existing view and matching on sourceURLs
email: (string) filter sources based on an email (a person)
links: (integer) for relationship maps, this denotes the minimum link strength (no. of connections) that makes up a link.
search: (string) for some widgets, this enables sub-filtering based on searches
types: (array) If set, only return data from sources matching these types
span: (integer) For factor charts, denotes the number of months to base factors on from
distinguish: (boolean) Enables distinguishing different types of data objects, subject to the individual API endpoint
from: (integer) If specified, compile data from this timestamp onwards
collapse: (string) for some widgets, this collapses sources based on a regex
source: (string) If specified, only compile data on this specific sourceID
unique: (boolean) Only compile data from unique commits, ignore duplicates

Input examples:

application/json:
{
    "interval": "month",
    "quick": false,
    "to": 1503483273,
    "span": 2,
    "types": [
        "jira",
        "bugzilla"
    ],
    "view": "abcdef12345678",
    "distinguish": false,
    "from": 1400000000,
    "source": "abcdef12345678"
}

Response examples:

200:
{
    "timeseries": [
        {
            "date": 1508273,
            "$item": 50,
            "$otheritem": 26
        }
    ]
}
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}
GET
/api/mail/top-authors
Shows the top N of email authors

JSON parameters:


Response examples:

200:
{}
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}
POST
/api/mail/top-authors
Shows the top N of email authors

JSON parameters:

quick: (boolean) Turns on quick data for some endpoints, returning only sparse data (thus less traffic)
to: (integer) If specified, only compile data up until here
view: (string) ID Of optional view to use
sources: (boolean) for some widget, this fetches all sources
author: (boolean) Turns on author view for code results, as opposed to the default committer view
interval: (string) If fetching histograms, this specifies the interval to pack figures into. Can be day, week, month, quarter or year
subfilter: (string) Quickly defined view by sub-filtering the existing view and matching on sourceURLs
email: (string) filter sources based on an email (a person)
links: (integer) for relationship maps, this denotes the minimum link strength (no. of connections) that makes up a link.
search: (string) for some widgets, this enables sub-filtering based on searches
types: (array) If set, only return data from sources matching these types
span: (integer) For factor charts, denotes the number of months to base factors on from
distinguish: (boolean) Enables distinguishing different types of data objects, subject to the individual API endpoint
from: (integer) If specified, compile data from this timestamp onwards
collapse: (string) for some widgets, this collapses sources based on a regex
source: (string) If specified, only compile data on this specific sourceID
unique: (boolean) Only compile data from unique commits, ignore duplicates

Input examples:

application/json:
{
    "interval": "month",
    "quick": false,
    "to": 1503483273,
    "span": 2,
    "types": [
        "jira",
        "bugzilla"
    ],
    "view": "abcdef12345678",
    "distinguish": false,
    "from": 1400000000,
    "source": "abcdef12345678"
}

Response examples:

200:
{}
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}
GET
/api/mail/top-topics
Shows the top N of email authors

JSON parameters:


Response examples:

200:
{}
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}
POST
/api/mail/top-topics
Shows the top N of email authors

JSON parameters:

quick: (boolean) Turns on quick data for some endpoints, returning only sparse data (thus less traffic)
to: (integer) If specified, only compile data up until here
view: (string) ID Of optional view to use
sources: (boolean) for some widget, this fetches all sources
author: (boolean) Turns on author view for code results, as opposed to the default committer view
interval: (string) If fetching histograms, this specifies the interval to pack figures into. Can be day, week, month, quarter or year
subfilter: (string) Quickly defined view by sub-filtering the existing view and matching on sourceURLs
email: (string) filter sources based on an email (a person)
links: (integer) for relationship maps, this denotes the minimum link strength (no. of connections) that makes up a link.
search: (string) for some widgets, this enables sub-filtering based on searches
types: (array) If set, only return data from sources matching these types
span: (integer) For factor charts, denotes the number of months to base factors on from
distinguish: (boolean) Enables distinguishing different types of data objects, subject to the individual API endpoint
from: (integer) If specified, compile data from this timestamp onwards
collapse: (string) for some widgets, this collapses sources based on a regex
source: (string) If specified, only compile data on this specific sourceID
unique: (boolean) Only compile data from unique commits, ignore duplicates

Input examples:

application/json:
{
    "interval": "month",
    "quick": false,
    "to": 1503483273,
    "span": 2,
    "types": [
        "jira",
        "bugzilla"
    ],
    "view": "abcdef12345678",
    "distinguish": false,
    "from": 1400000000,
    "source": "abcdef12345678"
}

Response examples:

200:
{}
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}
POST
/api/mail/trends
Shows a quick email trend summary of the past 6 months for your org

JSON parameters:

quick: (boolean) Turns on quick data for some endpoints, returning only sparse data (thus less traffic)
to: (integer) If specified, only compile data up until here
view: (string) ID Of optional view to use
sources: (boolean) for some widget, this fetches all sources
author: (boolean) Turns on author view for code results, as opposed to the default committer view
interval: (string) If fetching histograms, this specifies the interval to pack figures into. Can be day, week, month, quarter or year
subfilter: (string) Quickly defined view by sub-filtering the existing view and matching on sourceURLs
email: (string) filter sources based on an email (a person)
links: (integer) for relationship maps, this denotes the minimum link strength (no. of connections) that makes up a link.
search: (string) for some widgets, this enables sub-filtering based on searches
types: (array) If set, only return data from sources matching these types
span: (integer) For factor charts, denotes the number of months to base factors on from
distinguish: (boolean) Enables distinguishing different types of data objects, subject to the individual API endpoint
from: (integer) If specified, compile data from this timestamp onwards
collapse: (string) for some widgets, this collapses sources based on a regex
source: (string) If specified, only compile data on this specific sourceID
unique: (boolean) Only compile data from unique commits, ignore duplicates

Input examples:

application/json:
{
    "interval": "month",
    "quick": false,
    "to": 1503483273,
    "span": 2,
    "types": [
        "jira",
        "bugzilla"
    ],
    "view": "abcdef12345678",
    "distinguish": false,
    "from": 1400000000,
    "source": "abcdef12345678"
}

Response examples:

200:
{}
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}
GET
/api/org/list
Lists the organisations you belong to (or all, if admin)

JSON parameters:


Response examples:

200:
{}
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}
POST
/api/org/list
Lists the organisations you belong to (or all, if admin)

JSON parameters:

quick: (boolean) Turns on quick data for some endpoints, returning only sparse data (thus less traffic)
to: (integer) If specified, only compile data up until here
view: (string) ID Of optional view to use
sources: (boolean) for some widget, this fetches all sources
author: (boolean) Turns on author view for code results, as opposed to the default committer view
interval: (string) If fetching histograms, this specifies the interval to pack figures into. Can be day, week, month, quarter or year
subfilter: (string) Quickly defined view by sub-filtering the existing view and matching on sourceURLs
email: (string) filter sources based on an email (a person)
links: (integer) for relationship maps, this denotes the minimum link strength (no. of connections) that makes up a link.
search: (string) for some widgets, this enables sub-filtering based on searches
types: (array) If set, only return data from sources matching these types
span: (integer) For factor charts, denotes the number of months to base factors on from
distinguish: (boolean) Enables distinguishing different types of data objects, subject to the individual API endpoint
from: (integer) If specified, compile data from this timestamp onwards
collapse: (string) for some widgets, this collapses sources based on a regex
source: (string) If specified, only compile data on this specific sourceID
unique: (boolean) Only compile data from unique commits, ignore duplicates

Input examples:

application/json:
{
    "interval": "month",
    "quick": false,
    "to": 1503483273,
    "span": 2,
    "types": [
        "jira",
        "bugzilla"
    ],
    "view": "abcdef12345678",
    "distinguish": false,
    "from": 1400000000,
    "source": "abcdef12345678"
}

Response examples:

200:
[
    {
        "id": "demo",
        "sourceCount": 45,
        "docCount": 973624,
        "name": "Kibble, Inc.",
        "description": "demo, inc. is awesome"
    }
]
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}
PUT
/api/org/list
Create a new organisation

JSON parameters:

id: (string) the ID of the organisation, can be anything.
desc: (string) A short description of the organisation
name: (string) The name of the organisation to create

Input examples:

application/json:
{
    "id": "demo",
    "desc": "Kibble, inc. is awesome",
    "name": "Kibble, Inc."
}

Response examples:

200:
{
    "message": "Action completed"
}
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}
DELETE
/api/org/members
Remove a person from an organisation

JSON parameters:

password: (string) Desired password for the account
admin: (boolean) when adding users to orgs, this signifies ownership
displayname: (string) A display name (e.g. full name) for the account
email: (string) Desired username (email address)
defaultOrganisation: (string) If editing an account, this sets the default org (if a member of it)

Input examples:

application/json:
{
    "password": "kibbledemo",
    "admin": false,
    "displayname": "Kibble Guest",
    "email": "guest@kibble.live",
    "defaultOrganisation": "demo"
}

Response examples:

200:
{
    "message": "Action completed"
}
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}
GET
/api/org/members
Lists the members of an organisation

JSON parameters:


Response examples:

200:
{}
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}
POST
/api/org/members
Lists the members of an organisation

JSON parameters:

quick: (boolean) Turns on quick data for some endpoints, returning only sparse data (thus less traffic)
to: (integer) If specified, only compile data up until here
view: (string) ID Of optional view to use
sources: (boolean) for some widget, this fetches all sources
author: (boolean) Turns on author view for code results, as opposed to the default committer view
interval: (string) If fetching histograms, this specifies the interval to pack figures into. Can be day, week, month, quarter or year
subfilter: (string) Quickly defined view by sub-filtering the existing view and matching on sourceURLs
email: (string) filter sources based on an email (a person)
links: (integer) for relationship maps, this denotes the minimum link strength (no. of connections) that makes up a link.
search: (string) for some widgets, this enables sub-filtering based on searches
types: (array) If set, only return data from sources matching these types
span: (integer) For factor charts, denotes the number of months to base factors on from
distinguish: (boolean) Enables distinguishing different types of data objects, subject to the individual API endpoint
from: (integer) If specified, compile data from this timestamp onwards
collapse: (string) for some widgets, this collapses sources based on a regex
source: (string) If specified, only compile data on this specific sourceID
unique: (boolean) Only compile data from unique commits, ignore duplicates

Input examples:

application/json:
{
    "interval": "month",
    "quick": false,
    "to": 1503483273,
    "span": 2,
    "types": [
        "jira",
        "bugzilla"
    ],
    "view": "abcdef12345678",
    "distinguish": false,
    "from": 1400000000,
    "source": "abcdef12345678"
}

Response examples:

200:
[
    {}
]
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}
PUT
/api/org/members
Invite a person to an organisation

JSON parameters:

password: (string) Desired password for the account
admin: (boolean) when adding users to orgs, this signifies ownership
displayname: (string) A display name (e.g. full name) for the account
email: (string) Desired username (email address)
defaultOrganisation: (string) If editing an account, this sets the default org (if a member of it)

Input examples:

application/json:
{
    "password": "kibbledemo",
    "admin": false,
    "displayname": "Kibble Guest",
    "email": "guest@kibble.live",
    "defaultOrganisation": "demo"
}

Response examples:

200:
{
    "message": "Action completed"
}
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}
GET
/api/org/sourcetypes
Lists the available source types supported by Kibble

JSON parameters:


Response examples:

200:
{}
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}
POST
/api/org/sourcetypes
Lists the available source types supported by Kibble

JSON parameters:

quick: (boolean) Turns on quick data for some endpoints, returning only sparse data (thus less traffic)
to: (integer) If specified, only compile data up until here
view: (string) ID Of optional view to use
sources: (boolean) for some widget, this fetches all sources
author: (boolean) Turns on author view for code results, as opposed to the default committer view
interval: (string) If fetching histograms, this specifies the interval to pack figures into. Can be day, week, month, quarter or year
subfilter: (string) Quickly defined view by sub-filtering the existing view and matching on sourceURLs
email: (string) filter sources based on an email (a person)
links: (integer) for relationship maps, this denotes the minimum link strength (no. of connections) that makes up a link.
search: (string) for some widgets, this enables sub-filtering based on searches
types: (array) If set, only return data from sources matching these types
span: (integer) For factor charts, denotes the number of months to base factors on from
distinguish: (boolean) Enables distinguishing different types of data objects, subject to the individual API endpoint
from: (integer) If specified, compile data from this timestamp onwards
collapse: (string) for some widgets, this collapses sources based on a regex
source: (string) If specified, only compile data on this specific sourceID
unique: (boolean) Only compile data from unique commits, ignore duplicates

Input examples:

application/json:
{
    "interval": "month",
    "quick": false,
    "to": 1503483273,
    "span": 2,
    "types": [
        "jira",
        "bugzilla"
    ],
    "view": "abcdef12345678",
    "distinguish": false,
    "from": 1400000000,
    "source": "abcdef12345678"
}

Response examples:

200:
{}
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}
POST
/api/org/trends
Shows a quick trend summary of the past 6 months for your org

JSON parameters:

quick: (boolean) Turns on quick data for some endpoints, returning only sparse data (thus less traffic)
to: (integer) If specified, only compile data up until here
view: (string) ID Of optional view to use
sources: (boolean) for some widget, this fetches all sources
author: (boolean) Turns on author view for code results, as opposed to the default committer view
interval: (string) If fetching histograms, this specifies the interval to pack figures into. Can be day, week, month, quarter or year
subfilter: (string) Quickly defined view by sub-filtering the existing view and matching on sourceURLs
email: (string) filter sources based on an email (a person)
links: (integer) for relationship maps, this denotes the minimum link strength (no. of connections) that makes up a link.
search: (string) for some widgets, this enables sub-filtering based on searches
types: (array) If set, only return data from sources matching these types
span: (integer) For factor charts, denotes the number of months to base factors on from
distinguish: (boolean) Enables distinguishing different types of data objects, subject to the individual API endpoint
from: (integer) If specified, compile data from this timestamp onwards
collapse: (string) for some widgets, this collapses sources based on a regex
source: (string) If specified, only compile data on this specific sourceID
unique: (boolean) Only compile data from unique commits, ignore duplicates

Input examples:

application/json:
{
    "interval": "month",
    "quick": false,
    "to": 1503483273,
    "span": 2,
    "types": [
        "jira",
        "bugzilla"
    ],
    "view": "abcdef12345678",
    "distinguish": false,
    "from": 1400000000,
    "source": "abcdef12345678"
}

Response examples:

200:
{}
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}
DELETE
/api/session
Log out (remove session)

JSON parameters:

id: (string) optional object ID
page: (string) optional page id

Input examples:

application/json:
{}

Response examples:

200:
{
    "message": "Action completed"
}
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}
GET
/api/session
Display your login details

JSON parameters:


Response examples:

200:
{
    "displayName": "Kibble Guest",
    "defaultOrganisation": "apache",
    "userLevel": "user",
    "username": "guest@kibble.live",
    "organisations": [
        "apache",
        "demo"
    ]
}
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}
PUT
/api/session
Log in

JSON parameters:

password: (string) User password
email: (string) Username (email)

Input examples:

application/json:
{
    "password": "kibbledemo",
    "email": "guest@kibble.live"
}

Response examples:

200:
{
    "message": "Action completed"
}
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}
DELETE
/api/sources
Delete an existing source

JSON parameters:

id: (string) source ID

Input examples:

application/json:
{}

Response examples:

GET
/api/sources
Fetches a list of all sources for this organisation

JSON parameters:


Response examples:

200:
{
    "sources": [
        {}
    ]
}
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}
PATCH
/api/sources
Edit an existing source

JSON parameters:

sourceID: (string) The SourceID of this source
organisation: (string) The organisation this source belongs to
password: (string) optional password for auth
type: (string) The type of source (git, svn, bugzilla, mail, etc)
sourceURL: (string) The origin URL of this source.
username: (string) optional username for auth
cookie: (string) optional session cookie for auth

Input examples:

application/json:
{}

Response examples:

200:
{
    "message": "Action completed"
}
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}
POST
/api/sources
Fetches a list of all sources for this organisation

JSON parameters:

quick: (boolean) Turns on quick data for some endpoints, returning only sparse data (thus less traffic)
to: (integer) If specified, only compile data up until here
view: (string) ID Of optional view to use
sources: (boolean) for some widget, this fetches all sources
author: (boolean) Turns on author view for code results, as opposed to the default committer view
interval: (string) If fetching histograms, this specifies the interval to pack figures into. Can be day, week, month, quarter or year
subfilter: (string) Quickly defined view by sub-filtering the existing view and matching on sourceURLs
email: (string) filter sources based on an email (a person)
links: (integer) for relationship maps, this denotes the minimum link strength (no. of connections) that makes up a link.
search: (string) for some widgets, this enables sub-filtering based on searches
types: (array) If set, only return data from sources matching these types
span: (integer) For factor charts, denotes the number of months to base factors on from
distinguish: (boolean) Enables distinguishing different types of data objects, subject to the individual API endpoint
from: (integer) If specified, compile data from this timestamp onwards
collapse: (string) for some widgets, this collapses sources based on a regex
source: (string) If specified, only compile data on this specific sourceID
unique: (boolean) Only compile data from unique commits, ignore duplicates

Input examples:

application/json:
{
    "interval": "month",
    "quick": false,
    "to": 1503483273,
    "span": 2,
    "types": [
        "jira",
        "bugzilla"
    ],
    "view": "abcdef12345678",
    "distinguish": false,
    "from": 1400000000,
    "source": "abcdef12345678"
}

Response examples:

200:
{
    "sources": [
        {}
    ]
}
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}
PUT
/api/sources
Add a new source

JSON parameters:

sources: (array) The sources in this organisation
organisation: (string) The organisation these sources belong to

Input examples:

application/json:
{
    "sources": [
        {}
    ]
}

Response examples:

200:
{
    "message": "Action completed"
}
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}
GET
/api/verify/{email}/{vcode}
Verify an account

JSON parameters:


Response examples:

200:
{
    "message": "Action completed"
}
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}
DELETE
/api/views
Delete a new view

JSON parameters:


Input examples:

application/json:
{}

Response examples:

200:
{
    "message": "Action completed"
}
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}
GET
/api/views
Fetches a list of all views (filters) for this user

JSON parameters:


Response examples:

200:
{
    "sources": [
        {}
    ],
    "organisation": "apache",
    "views": [
        {
            "sources": [
                {}
            ],
            "id": "abcdef67126734271",
            "organisation": "apache",
            "name": "Big Data Projects"
        }
    ]
}
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}
PATCH
/api/views
Edit an existing source

JSON parameters:


Input examples:

application/json:
{}

Response examples:

200:
{
    "message": "Action completed"
}
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}
POST
/api/views
Fetches a list of all views (filters) for this user

JSON parameters:

quick: (boolean) Turns on quick data for some endpoints, returning only sparse data (thus less traffic)
to: (integer) If specified, only compile data up until here
view: (string) ID Of optional view to use
sources: (boolean) for some widget, this fetches all sources
author: (boolean) Turns on author view for code results, as opposed to the default committer view
interval: (string) If fetching histograms, this specifies the interval to pack figures into. Can be day, week, month, quarter or year
subfilter: (string) Quickly defined view by sub-filtering the existing view and matching on sourceURLs
email: (string) filter sources based on an email (a person)
links: (integer) for relationship maps, this denotes the minimum link strength (no. of connections) that makes up a link.
search: (string) for some widgets, this enables sub-filtering based on searches
types: (array) If set, only return data from sources matching these types
span: (integer) For factor charts, denotes the number of months to base factors on from
distinguish: (boolean) Enables distinguishing different types of data objects, subject to the individual API endpoint
from: (integer) If specified, compile data from this timestamp onwards
collapse: (string) for some widgets, this collapses sources based on a regex
source: (string) If specified, only compile data on this specific sourceID
unique: (boolean) Only compile data from unique commits, ignore duplicates

Input examples:

application/json:
{
    "interval": "month",
    "quick": false,
    "to": 1503483273,
    "span": 2,
    "types": [
        "jira",
        "bugzilla"
    ],
    "view": "abcdef12345678",
    "distinguish": false,
    "from": 1400000000,
    "source": "abcdef12345678"
}

Response examples:

200:
{
    "sources": [
        {}
    ],
    "organisation": "apache",
    "views": [
        {
            "sources": [
                {}
            ],
            "id": "abcdef67126734271",
            "organisation": "apache",
            "name": "Big Data Projects"
        }
    ]
}
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}
PUT
/api/views
Add a new view

JSON parameters:


Input examples:

application/json:
{}

Response examples:

200:
{
    "message": "Action completed"
}
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}
GET
/api/widgets/{pageid}
Shows the widget layout for a specific page

JSON parameters:


Response examples:

200:
{
    "rows": [
        {
            "children": [
                {
                    "blocks": 4,
                    "representation": "donut",
                    "name": "Widget Title",
                    "datatype": "repo",
                    "source": "code-evolution",
                    "type": "My Widget"
                }
            ]
        }
    ]
}
default:
{
    "code": 403,
    "reason": "You need to be logged in to view this endpoint!"
}