| |
| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| </head> |
| <body> |
| |
| <h3>Overview:</h3><ul style='font-size: 12px; font-family: Open Sans, sans-serif;'><li><a href='#delete-api-account'>DELETE /api/account</a>: Delete an account</li> |
| <li><a href='#patch-api-account'>PATCH /api/account</a>: Edit an account</li> |
| <li><a href='#put-api-account'>PUT /api/account</a>: Create a new account</li> |
| <li><a href='#get-api-bio-bio'>GET /api/bio/bio</a>: Shows some facts about a contributor</li> |
| <li><a href='#post-api-bio-bio'>POST /api/bio/bio</a>: Shows some facts about a contributor</li> |
| <li><a href='#get-api-bio-trends'>GET /api/bio/trends</a>: Shows a quick trend summary of the past 6 months for a contributor</li> |
| <li><a href='#post-api-bio-trends'>POST /api/bio/trends</a>: Shows a quick trend summary of the past 6 months for a contributor</li> |
| <li><a href='#get-api-code-changes'>GET /api/code/changes</a>: Show insertions/deletions as a timeseries</li> |
| <li><a href='#post-api-code-changes'>POST /api/code/changes</a>: Show insertions/deletions as a timeseries</li> |
| <li><a href='#get-api-code-commits'>GET /api/code/commits</a>: Show commits as a timeseries</li> |
| <li><a href='#post-api-code-commits'>POST /api/code/commits</a>: Show commits as a timeseries</li> |
| <li><a href='#get-api-code-committers'>GET /api/code/committers</a>: Shows the top N of committers</li> |
| <li><a href='#post-api-code-committers'>POST /api/code/committers</a>: Shows trend data for a set of repos over a given period of time</li> |
| <li><a href='#get-api-code-evolution'>GET /api/code/evolution</a>: Show code evolution as a timeseries</li> |
| <li><a href='#post-api-code-evolution'>POST /api/code/evolution</a>: Show code evolution as a timeseries</li> |
| <li><a href='#get-api-code-pony'>GET /api/code/pony</a>: Shows pony factor data for a set of repos over a given period of time</li> |
| <li><a href='#post-api-code-pony'>POST /api/code/pony</a>: Shows pony factor data for a set of repos over a given period of time</li> |
| <li><a href='#get-api-code-pony-timeseries'>GET /api/code/pony-timeseries</a>: Shows timeseries of Pony Factor over time</li> |
| <li><a href='#post-api-code-pony-timeseries'>POST /api/code/pony-timeseries</a>: Shows timeseries of Pony Factor over time</li> |
| <li><a href='#get-api-code-relationships'>GET /api/code/relationships</a>: Shows a breakdown of contributor relationships between repositories</li> |
| <li><a href='#post-api-code-relationships'>POST /api/code/relationships</a>: Shows a breakdown of contributor relationships between repositories</li> |
| <li><a href='#get-api-code-retention'>GET /api/code/retention</a>: Shows retention metrics for a set of repos over a given period of time</li> |
| <li><a href='#post-api-code-retention'>POST /api/code/retention</a>: Shows retention metrics for a set of repos over a given period of time</li> |
| <li><a href='#get-api-code-sloc'>GET /api/code/sloc</a>: Shows a breakdown of lines of code for one or more sources</li> |
| <li><a href='#post-api-code-sloc'>POST /api/code/sloc</a>: Shows a breakdown of lines of code for one or more sources</li> |
| <li><a href='#get-api-code-top-commits'>GET /api/code/top-commits</a>: Shows top 25 repos by commit volume</li> |
| <li><a href='#post-api-code-top-commits'>POST /api/code/top-commits</a>: Shows top 25 repos by commit volume</li> |
| <li><a href='#get-api-code-top-sloc'>GET /api/code/top-sloc</a>: Shows top 25 repos by lines of code</li> |
| <li><a href='#post-api-code-top-sloc'>POST /api/code/top-sloc</a>: Shows top 25 repos by lines of code</li> |
| <li><a href='#get-api-code-trends'>GET /api/code/trends</a>: Shows trend data for a set of repos over a given period of time</li> |
| <li><a href='#post-api-code-trends'>POST /api/code/trends</a>: Shows trend data for a set of repos over a given period of time</li> |
| <li><a href='#get-api-issue-actors'>GET /api/issue/actors</a>: Shows timeseries of no. of people opening/closing issues over time</li> |
| <li><a href='#post-api-issue-actors'>POST /api/issue/actors</a>: Shows timeseries of no. of people opening/closing issues over time</li> |
| <li><a href='#get-api-issue-age'>GET /api/issue/age</a>: Shows timeseries of no. of open tickets by age</li> |
| <li><a href='#post-api-issue-age'>POST /api/issue/age</a>: Shows timeseries of no. of open tickets by age</li> |
| <li><a href='#get-api-issue-closers'>GET /api/issue/closers</a>: Shows the top N of issue closers</li> |
| <li><a href='#post-api-issue-closers'>POST /api/issue/closers</a>: Shows the top N of issue closers</li> |
| <li><a href='#get-api-issue-issues'>GET /api/issue/issues</a>: Shows timeseries of issues opened/closed over time</li> |
| <li><a href='#post-api-issue-issues'>POST /api/issue/issues</a>: Shows timeseries of issues opened/closed over time</li> |
| <li><a href='#get-api-issue-openers'>GET /api/issue/openers</a>: Shows the top N of issue openers</li> |
| <li><a href='#post-api-issue-openers'>POST /api/issue/openers</a>: Shows the top N of issue openers</li> |
| <li><a href='#get-api-issue-pony-timeseries'>GET /api/issue/pony-timeseries</a>: Shows timeseries of Pony Factor over time</li> |
| <li><a href='#post-api-issue-pony-timeseries'>POST /api/issue/pony-timeseries</a>: Shows timeseries of Pony Factor over time</li> |
| <li><a href='#get-api-issue-relationships'>GET /api/issue/relationships</a>: Shows a breakdown of contributor relationships between issue trackers</li> |
| <li><a href='#post-api-issue-relationships'>POST /api/issue/relationships</a>: Shows a breakdown of contributor relationships between issue trackers</li> |
| <li><a href='#get-api-issue-retention'>GET /api/issue/retention</a>: Shows retention metrics for a set of issue trackers over a given period of time</li> |
| <li><a href='#post-api-issue-retention'>POST /api/issue/retention</a>: Shows retention metrics for a set of issue trackers over a given period of time</li> |
| <li><a href='#get-api-issue-top'>GET /api/issue/top</a>: Shows the top N issues by interactions</li> |
| <li><a href='#post-api-issue-top'>POST /api/issue/top</a>: Shows the top N issues by interactions</li> |
| <li><a href='#get-api-issue-top-count'>GET /api/issue/top-count</a>: Shows top 25 issue trackers by issues</li> |
| <li><a href='#post-api-issue-top-count'>POST /api/issue/top-count</a>: Shows top 25 issue trackers by issues</li> |
| <li><a href='#get-api-issue-trends'>GET /api/issue/trends</a>: Shows trend data for a set of issue trackers over a given period of time</li> |
| <li><a href='#post-api-issue-trends'>POST /api/issue/trends</a>: Shows trend data for a set of issue trackers over a given period of time</li> |
| <li><a href='#get-api-mail-map'>GET /api/mail/map</a>: Shows a breakdown of email author reply mappings</li> |
| <li><a href='#post-api-mail-map'>POST /api/mail/map</a>: Shows a breakdown of email author reply mappings</li> |
| <li><a href='#get-api-mail-pony-timeseries'>GET /api/mail/pony-timeseries</a>: Shows timeseries of Pony Factor over time</li> |
| <li><a href='#post-api-mail-pony-timeseries'>POST /api/mail/pony-timeseries</a>: Shows timeseries of Pony Factor over time</li> |
| <li><a href='#get-api-mail-relationships'>GET /api/mail/relationships</a>: Shows a breakdown of contributor relationships between mailing lists</li> |
| <li><a href='#post-api-mail-relationships'>POST /api/mail/relationships</a>: Shows a breakdown of contributor relationships between mailing lists</li> |
| <li><a href='#get-api-mail-retention'>GET /api/mail/retention</a>: Shows retention metrics for a set of mailing lists over a given period of time</li> |
| <li><a href='#post-api-mail-retention'>POST /api/mail/retention</a>: Shows retention metrics for a set of mailing lists over a given period of time</li> |
| <li><a href='#get-api-mail-timeseries'>GET /api/mail/timeseries</a>: Shows email sent over time</li> |
| <li><a href='#post-api-mail-timeseries'>POST /api/mail/timeseries</a>: Shows email sent over time</li> |
| <li><a href='#get-api-mail-timeseries-single'>GET /api/mail/timeseries-single</a>: Shows email sent over time</li> |
| <li><a href='#post-api-mail-timeseries-single'>POST /api/mail/timeseries-single</a>: Shows email sent over time</li> |
| <li><a href='#get-api-mail-top-authors'>GET /api/mail/top-authors</a>: Shows the top N of email authors</li> |
| <li><a href='#post-api-mail-top-authors'>POST /api/mail/top-authors</a>: Shows the top N of email authors</li> |
| <li><a href='#get-api-mail-top-topics'>GET /api/mail/top-topics</a>: Shows the top N of email authors</li> |
| <li><a href='#post-api-mail-top-topics'>POST /api/mail/top-topics</a>: Shows the top N of email authors</li> |
| <li><a href='#get-api-mail-trends'>GET /api/mail/trends</a>: Shows a quick email trend summary of the past 6 months for your org</li> |
| <li><a href='#post-api-mail-trends'>POST /api/mail/trends</a>: Shows a quick email trend summary of the past 6 months for your org</li> |
| <li><a href='#get-api-org-list'>GET /api/org/list</a>: Lists the organisations you belong to (or all, if admin)</li> |
| <li><a href='#post-api-org-list'>POST /api/org/list</a>: Lists the organisations you belong to (or all, if admin)</li> |
| <li><a href='#put-api-org-list'>PUT /api/org/list</a>: Create a new organisation</li> |
| <li><a href='#delete-api-org-members'>DELETE /api/org/members</a>: Remove a person from an organisation</li> |
| <li><a href='#get-api-org-members'>GET /api/org/members</a>: Lists the members of an organisation</li> |
| <li><a href='#post-api-org-members'>POST /api/org/members</a>: Lists the members of an organisation</li> |
| <li><a href='#put-api-org-members'>PUT /api/org/members</a>: Invite a person to an organisation</li> |
| <li><a href='#get-api-org-sourcetypes'>GET /api/org/sourcetypes</a>: Lists the available source types supported by Kibble</li> |
| <li><a href='#post-api-org-sourcetypes'>POST /api/org/sourcetypes</a>: Lists the available source types supported by Kibble</li> |
| <li><a href='#get-api-org-trends'>GET /api/org/trends</a>: Shows a quick trend summary of the past 6 months for your org</li> |
| <li><a href='#post-api-org-trends'>POST /api/org/trends</a>: Shows a quick trend summary of the past 6 months for your org</li> |
| <li><a href='#delete-api-session'>DELETE /api/session</a>: Log out (remove session)</li> |
| <li><a href='#get-api-session'>GET /api/session</a>: Display your login details</li> |
| <li><a href='#put-api-session'>PUT /api/session</a>: Log in</li> |
| <li><a href='#delete-api-sources'>DELETE /api/sources</a>: Delete an existing source</li> |
| <li><a href='#get-api-sources'>GET /api/sources</a>: Fetches a list of all sources for this organisation</li> |
| <li><a href='#patch-api-sources'>PATCH /api/sources</a>: Edit an existing source</li> |
| <li><a href='#post-api-sources'>POST /api/sources</a>: Fetches a list of all sources for this organisation</li> |
| <li><a href='#put-api-sources'>PUT /api/sources</a>: Add a new source</li> |
| <li><a href='#get-api-verify-{email}-{vcode}'>GET /api/verify/{email}/{vcode}</a>: Verify an account</li> |
| <li><a href='#delete-api-views'>DELETE /api/views</a>: Delete a new view</li> |
| <li><a href='#get-api-views'>GET /api/views</a>: Fetches a list of all views (filters) for this user</li> |
| <li><a href='#patch-api-views'>PATCH /api/views</a>: Edit an existing source</li> |
| <li><a href='#post-api-views'>POST /api/views</a>: Fetches a list of all views (filters) for this user</li> |
| <li><a href='#put-api-views'>PUT /api/views</a>: Add a new view</li> |
| <li><a href='#get-api-widgets-{pageid}'>GET /api/widgets/{pageid}</a>: Shows the widget layout for a specific page</li> |
| </ul> |
| |
| <div id="delete-api-account" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #f93e3e; font-family: sans-serif; background: #f93e3e30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #f93e3e;">DELETE</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/account</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Delete an account</div> |
| <div style="float: left; width: 90%;display: block; "> |
| <h4>JSON parameters:</h4> |
| |
| <br/> |
| <div style='float: left; width: 90%;'><h4>Input examples:</h4><blockquote><pre style='width: 600px;'><b>application/json</b>: |
| { |
| "username": "kibbleguest" |
| }</pre></blockquote> |
| </div> |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| { |
| "message": "Action completed" |
| }</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="patch-api-account" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #d5a37e; font-family: sans-serif; background: #d5a37e30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #d5a37e;">PATCH</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/account</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Edit an account</div> |
| <div style="float: left; width: 90%;display: block; "> |
| <h4>JSON parameters:</h4> |
| <div style='float: left; width: 90%;'><blockquote><pre style='width: 600px;'><kbd><b>password:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Desired password for the account</span><br/> |
| <kbd><b>admin:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>when adding users to orgs, this signifies ownership</span><br/> |
| <kbd><b>displayname:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>A display name (e.g. full name) for the account</span><br/> |
| <kbd><b>email:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Desired username (email address)</span><br/> |
| <kbd><b>defaultOrganisation:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If editing an account, this sets the default org (if a member of it)</span><br/> |
| </pre> |
| </blockquote></div> |
| <br/> |
| <div style='float: left; width: 90%;'><h4>Input examples:</h4><blockquote><pre style='width: 600px;'><b>application/json</b>: |
| { |
| "password": "kibbledemo", |
| "admin": false, |
| "displayname": "Kibble Guest", |
| "email": "guest@kibble.live", |
| "defaultOrganisation": "demo" |
| }</pre></blockquote> |
| </div> |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| { |
| "message": "Action completed" |
| }</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="put-api-account" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #fca130; font-family: sans-serif; background: #fca13030;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #fca130;">PUT</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/account</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Create a new account</div> |
| <div style="float: left; width: 90%;display: block; "> |
| <h4>JSON parameters:</h4> |
| <div style='float: left; width: 90%;'><blockquote><pre style='width: 600px;'><kbd><b>password:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Desired password for the account</span><br/> |
| <kbd><b>displayname:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>A display name (e.g. full name) for the account</span><br/> |
| <kbd><b>email:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Desired username (email address)</span><br/> |
| </pre> |
| </blockquote></div> |
| <br/> |
| <div style='float: left; width: 90%;'><h4>Input examples:</h4><blockquote><pre style='width: 600px;'><b>application/json</b>: |
| { |
| "password": "kibbledemo", |
| "displayname": "Kibble Guest", |
| "email": "guest@kibble.live" |
| }</pre></blockquote> |
| </div> |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| { |
| "message": "Action completed" |
| }</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="get-api-bio-bio" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #61affe; font-family: sans-serif; background: #61affe30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #61affe;">GET</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/bio/bio</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Shows some facts about a contributor</div> |
| <div style="float: left; width: 90%;display: none; "> |
| <h4>JSON parameters:</h4> |
| |
| <br/> |
| |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| {}</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="post-api-bio-bio" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #49cc5c; font-family: sans-serif; background: #49cc5c30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #49cc5c;">POST</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/bio/bio</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Shows some facts about a contributor</div> |
| <div style="float: left; width: 90%;display: block; "> |
| <h4>JSON parameters:</h4> |
| <div style='float: left; width: 90%;'><blockquote><pre style='width: 600px;'><kbd><b>quick:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Turns on quick data for some endpoints, returning only sparse data (thus less traffic)</span><br/> |
| <kbd><b>to:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, only compile data up until here</span><br/> |
| <kbd><b>view:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>ID Of optional view to use</span><br/> |
| <kbd><b>sources:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widget, this fetches all sources</span><br/> |
| <kbd><b>author:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Turns on author view for code results, as opposed to the default committer view</span><br/> |
| <kbd><b>interval:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If fetching histograms, this specifies the interval to pack figures into. Can be day, week, month, quarter or year</span><br/> |
| <kbd><b>subfilter:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Quickly defined view by sub-filtering the existing view and matching on sourceURLs</span><br/> |
| <kbd><b>email:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>filter sources based on an email (a person)</span><br/> |
| <kbd><b>links:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for relationship maps, this denotes the minimum link strength (no. of connections) that makes up a link.</span><br/> |
| <kbd><b>search:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widgets, this enables sub-filtering based on searches</span><br/> |
| <kbd><b>types:</b></kbd> (array) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If set, only return data from sources matching these types</span><br/> |
| <kbd><b>span:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>For factor charts, denotes the number of months to base factors on from</span><br/> |
| <kbd><b>distinguish:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Enables distinguishing different types of data objects, subject to the individual API endpoint</span><br/> |
| <kbd><b>from:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, compile data from this timestamp onwards</span><br/> |
| <kbd><b>collapse:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widgets, this collapses sources based on a regex</span><br/> |
| <kbd><b>source:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, only compile data on this specific sourceID</span><br/> |
| <kbd><b>unique:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Only compile data from unique commits, ignore duplicates</span><br/> |
| </pre> |
| </blockquote></div> |
| <br/> |
| <div style='float: left; width: 90%;'><h4>Input examples:</h4><blockquote><pre style='width: 600px;'><b>application/json</b>: |
| { |
| "interval": "month", |
| "quick": false, |
| "to": 1503483273, |
| "span": 2, |
| "types": [ |
| "jira", |
| "bugzilla" |
| ], |
| "view": "abcdef12345678", |
| "distinguish": false, |
| "from": 1400000000, |
| "source": "abcdef12345678" |
| }</pre></blockquote> |
| </div> |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| {}</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="get-api-bio-trends" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #61affe; font-family: sans-serif; background: #61affe30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #61affe;">GET</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/bio/trends</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Shows a quick trend summary of the past 6 months for a contributor</div> |
| <div style="float: left; width: 90%;display: none; "> |
| <h4>JSON parameters:</h4> |
| |
| <br/> |
| |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| {}</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="post-api-bio-trends" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #49cc5c; font-family: sans-serif; background: #49cc5c30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #49cc5c;">POST</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/bio/trends</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Shows a quick trend summary of the past 6 months for a contributor</div> |
| <div style="float: left; width: 90%;display: block; "> |
| <h4>JSON parameters:</h4> |
| <div style='float: left; width: 90%;'><blockquote><pre style='width: 600px;'><kbd><b>quick:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Turns on quick data for some endpoints, returning only sparse data (thus less traffic)</span><br/> |
| <kbd><b>to:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, only compile data up until here</span><br/> |
| <kbd><b>view:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>ID Of optional view to use</span><br/> |
| <kbd><b>sources:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widget, this fetches all sources</span><br/> |
| <kbd><b>author:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Turns on author view for code results, as opposed to the default committer view</span><br/> |
| <kbd><b>interval:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If fetching histograms, this specifies the interval to pack figures into. Can be day, week, month, quarter or year</span><br/> |
| <kbd><b>subfilter:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Quickly defined view by sub-filtering the existing view and matching on sourceURLs</span><br/> |
| <kbd><b>email:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>filter sources based on an email (a person)</span><br/> |
| <kbd><b>links:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for relationship maps, this denotes the minimum link strength (no. of connections) that makes up a link.</span><br/> |
| <kbd><b>search:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widgets, this enables sub-filtering based on searches</span><br/> |
| <kbd><b>types:</b></kbd> (array) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If set, only return data from sources matching these types</span><br/> |
| <kbd><b>span:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>For factor charts, denotes the number of months to base factors on from</span><br/> |
| <kbd><b>distinguish:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Enables distinguishing different types of data objects, subject to the individual API endpoint</span><br/> |
| <kbd><b>from:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, compile data from this timestamp onwards</span><br/> |
| <kbd><b>collapse:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widgets, this collapses sources based on a regex</span><br/> |
| <kbd><b>source:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, only compile data on this specific sourceID</span><br/> |
| <kbd><b>unique:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Only compile data from unique commits, ignore duplicates</span><br/> |
| </pre> |
| </blockquote></div> |
| <br/> |
| <div style='float: left; width: 90%;'><h4>Input examples:</h4><blockquote><pre style='width: 600px;'><b>application/json</b>: |
| { |
| "interval": "month", |
| "quick": false, |
| "to": 1503483273, |
| "span": 2, |
| "types": [ |
| "jira", |
| "bugzilla" |
| ], |
| "view": "abcdef12345678", |
| "distinguish": false, |
| "from": 1400000000, |
| "source": "abcdef12345678" |
| }</pre></blockquote> |
| </div> |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| {}</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="get-api-code-changes" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #61affe; font-family: sans-serif; background: #61affe30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #61affe;">GET</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/code/changes</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Show insertions/deletions as a timeseries</div> |
| <div style="float: left; width: 90%;display: none; "> |
| <h4>JSON parameters:</h4> |
| |
| <br/> |
| |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| { |
| "timeseries": [ |
| { |
| "date": 1508273, |
| "$item": 50, |
| "$otheritem": 26 |
| } |
| ] |
| }</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="post-api-code-changes" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #49cc5c; font-family: sans-serif; background: #49cc5c30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #49cc5c;">POST</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/code/changes</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Show insertions/deletions as a timeseries</div> |
| <div style="float: left; width: 90%;display: block; "> |
| <h4>JSON parameters:</h4> |
| <div style='float: left; width: 90%;'><blockquote><pre style='width: 600px;'><kbd><b>quick:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Turns on quick data for some endpoints, returning only sparse data (thus less traffic)</span><br/> |
| <kbd><b>to:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, only compile data up until here</span><br/> |
| <kbd><b>view:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>ID Of optional view to use</span><br/> |
| <kbd><b>sources:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widget, this fetches all sources</span><br/> |
| <kbd><b>author:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Turns on author view for code results, as opposed to the default committer view</span><br/> |
| <kbd><b>interval:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If fetching histograms, this specifies the interval to pack figures into. Can be day, week, month, quarter or year</span><br/> |
| <kbd><b>subfilter:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Quickly defined view by sub-filtering the existing view and matching on sourceURLs</span><br/> |
| <kbd><b>email:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>filter sources based on an email (a person)</span><br/> |
| <kbd><b>links:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for relationship maps, this denotes the minimum link strength (no. of connections) that makes up a link.</span><br/> |
| <kbd><b>search:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widgets, this enables sub-filtering based on searches</span><br/> |
| <kbd><b>types:</b></kbd> (array) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If set, only return data from sources matching these types</span><br/> |
| <kbd><b>span:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>For factor charts, denotes the number of months to base factors on from</span><br/> |
| <kbd><b>distinguish:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Enables distinguishing different types of data objects, subject to the individual API endpoint</span><br/> |
| <kbd><b>from:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, compile data from this timestamp onwards</span><br/> |
| <kbd><b>collapse:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widgets, this collapses sources based on a regex</span><br/> |
| <kbd><b>source:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, only compile data on this specific sourceID</span><br/> |
| <kbd><b>unique:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Only compile data from unique commits, ignore duplicates</span><br/> |
| </pre> |
| </blockquote></div> |
| <br/> |
| <div style='float: left; width: 90%;'><h4>Input examples:</h4><blockquote><pre style='width: 600px;'><b>application/json</b>: |
| { |
| "interval": "month", |
| "quick": false, |
| "to": 1503483273, |
| "span": 2, |
| "types": [ |
| "jira", |
| "bugzilla" |
| ], |
| "view": "abcdef12345678", |
| "distinguish": false, |
| "from": 1400000000, |
| "source": "abcdef12345678" |
| }</pre></blockquote> |
| </div> |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| { |
| "timeseries": [ |
| { |
| "date": 1508273, |
| "$item": 50, |
| "$otheritem": 26 |
| } |
| ] |
| }</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="get-api-code-commits" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #61affe; font-family: sans-serif; background: #61affe30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #61affe;">GET</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/code/commits</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Show commits as a timeseries</div> |
| <div style="float: left; width: 90%;display: none; "> |
| <h4>JSON parameters:</h4> |
| |
| <br/> |
| |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| { |
| "timeseries": [ |
| { |
| "date": 1508273, |
| "$item": 50, |
| "$otheritem": 26 |
| } |
| ] |
| }</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="post-api-code-commits" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #49cc5c; font-family: sans-serif; background: #49cc5c30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #49cc5c;">POST</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/code/commits</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Show commits as a timeseries</div> |
| <div style="float: left; width: 90%;display: block; "> |
| <h4>JSON parameters:</h4> |
| <div style='float: left; width: 90%;'><blockquote><pre style='width: 600px;'><kbd><b>quick:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Turns on quick data for some endpoints, returning only sparse data (thus less traffic)</span><br/> |
| <kbd><b>to:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, only compile data up until here</span><br/> |
| <kbd><b>view:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>ID Of optional view to use</span><br/> |
| <kbd><b>sources:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widget, this fetches all sources</span><br/> |
| <kbd><b>author:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Turns on author view for code results, as opposed to the default committer view</span><br/> |
| <kbd><b>interval:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If fetching histograms, this specifies the interval to pack figures into. Can be day, week, month, quarter or year</span><br/> |
| <kbd><b>subfilter:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Quickly defined view by sub-filtering the existing view and matching on sourceURLs</span><br/> |
| <kbd><b>email:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>filter sources based on an email (a person)</span><br/> |
| <kbd><b>links:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for relationship maps, this denotes the minimum link strength (no. of connections) that makes up a link.</span><br/> |
| <kbd><b>search:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widgets, this enables sub-filtering based on searches</span><br/> |
| <kbd><b>types:</b></kbd> (array) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If set, only return data from sources matching these types</span><br/> |
| <kbd><b>span:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>For factor charts, denotes the number of months to base factors on from</span><br/> |
| <kbd><b>distinguish:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Enables distinguishing different types of data objects, subject to the individual API endpoint</span><br/> |
| <kbd><b>from:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, compile data from this timestamp onwards</span><br/> |
| <kbd><b>collapse:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widgets, this collapses sources based on a regex</span><br/> |
| <kbd><b>source:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, only compile data on this specific sourceID</span><br/> |
| <kbd><b>unique:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Only compile data from unique commits, ignore duplicates</span><br/> |
| </pre> |
| </blockquote></div> |
| <br/> |
| <div style='float: left; width: 90%;'><h4>Input examples:</h4><blockquote><pre style='width: 600px;'><b>application/json</b>: |
| { |
| "interval": "month", |
| "quick": false, |
| "to": 1503483273, |
| "span": 2, |
| "types": [ |
| "jira", |
| "bugzilla" |
| ], |
| "view": "abcdef12345678", |
| "distinguish": false, |
| "from": 1400000000, |
| "source": "abcdef12345678" |
| }</pre></blockquote> |
| </div> |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| { |
| "timeseries": [ |
| { |
| "date": 1508273, |
| "$item": 50, |
| "$otheritem": 26 |
| } |
| ] |
| }</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="get-api-code-committers" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #61affe; font-family: sans-serif; background: #61affe30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #61affe;">GET</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/code/committers</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Shows the top N of committers</div> |
| <div style="float: left; width: 90%;display: none; "> |
| <h4>JSON parameters:</h4> |
| |
| <br/> |
| |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| {}</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="post-api-code-committers" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #49cc5c; font-family: sans-serif; background: #49cc5c30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #49cc5c;">POST</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/code/committers</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Shows trend data for a set of repos over a given period of time</div> |
| <div style="float: left; width: 90%;display: block; "> |
| <h4>JSON parameters:</h4> |
| <div style='float: left; width: 90%;'><blockquote><pre style='width: 600px;'><kbd><b>quick:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Turns on quick data for some endpoints, returning only sparse data (thus less traffic)</span><br/> |
| <kbd><b>to:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, only compile data up until here</span><br/> |
| <kbd><b>view:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>ID Of optional view to use</span><br/> |
| <kbd><b>sources:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widget, this fetches all sources</span><br/> |
| <kbd><b>author:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Turns on author view for code results, as opposed to the default committer view</span><br/> |
| <kbd><b>interval:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If fetching histograms, this specifies the interval to pack figures into. Can be day, week, month, quarter or year</span><br/> |
| <kbd><b>subfilter:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Quickly defined view by sub-filtering the existing view and matching on sourceURLs</span><br/> |
| <kbd><b>email:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>filter sources based on an email (a person)</span><br/> |
| <kbd><b>links:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for relationship maps, this denotes the minimum link strength (no. of connections) that makes up a link.</span><br/> |
| <kbd><b>search:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widgets, this enables sub-filtering based on searches</span><br/> |
| <kbd><b>types:</b></kbd> (array) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If set, only return data from sources matching these types</span><br/> |
| <kbd><b>span:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>For factor charts, denotes the number of months to base factors on from</span><br/> |
| <kbd><b>distinguish:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Enables distinguishing different types of data objects, subject to the individual API endpoint</span><br/> |
| <kbd><b>from:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, compile data from this timestamp onwards</span><br/> |
| <kbd><b>collapse:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widgets, this collapses sources based on a regex</span><br/> |
| <kbd><b>source:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, only compile data on this specific sourceID</span><br/> |
| <kbd><b>unique:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Only compile data from unique commits, ignore duplicates</span><br/> |
| </pre> |
| </blockquote></div> |
| <br/> |
| <div style='float: left; width: 90%;'><h4>Input examples:</h4><blockquote><pre style='width: 600px;'><b>application/json</b>: |
| { |
| "interval": "month", |
| "quick": false, |
| "to": 1503483273, |
| "span": 2, |
| "types": [ |
| "jira", |
| "bugzilla" |
| ], |
| "view": "abcdef12345678", |
| "distinguish": false, |
| "from": 1400000000, |
| "source": "abcdef12345678" |
| }</pre></blockquote> |
| </div> |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| {}</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="get-api-code-evolution" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #61affe; font-family: sans-serif; background: #61affe30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #61affe;">GET</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/code/evolution</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Show code evolution as a timeseries</div> |
| <div style="float: left; width: 90%;display: none; "> |
| <h4>JSON parameters:</h4> |
| |
| <br/> |
| |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| { |
| "timeseries": [ |
| { |
| "date": 1508273, |
| "$item": 50, |
| "$otheritem": 26 |
| } |
| ] |
| }</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="post-api-code-evolution" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #49cc5c; font-family: sans-serif; background: #49cc5c30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #49cc5c;">POST</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/code/evolution</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Show code evolution as a timeseries</div> |
| <div style="float: left; width: 90%;display: block; "> |
| <h4>JSON parameters:</h4> |
| <div style='float: left; width: 90%;'><blockquote><pre style='width: 600px;'><kbd><b>quick:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Turns on quick data for some endpoints, returning only sparse data (thus less traffic)</span><br/> |
| <kbd><b>to:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, only compile data up until here</span><br/> |
| <kbd><b>view:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>ID Of optional view to use</span><br/> |
| <kbd><b>sources:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widget, this fetches all sources</span><br/> |
| <kbd><b>author:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Turns on author view for code results, as opposed to the default committer view</span><br/> |
| <kbd><b>interval:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If fetching histograms, this specifies the interval to pack figures into. Can be day, week, month, quarter or year</span><br/> |
| <kbd><b>subfilter:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Quickly defined view by sub-filtering the existing view and matching on sourceURLs</span><br/> |
| <kbd><b>email:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>filter sources based on an email (a person)</span><br/> |
| <kbd><b>links:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for relationship maps, this denotes the minimum link strength (no. of connections) that makes up a link.</span><br/> |
| <kbd><b>search:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widgets, this enables sub-filtering based on searches</span><br/> |
| <kbd><b>types:</b></kbd> (array) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If set, only return data from sources matching these types</span><br/> |
| <kbd><b>span:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>For factor charts, denotes the number of months to base factors on from</span><br/> |
| <kbd><b>distinguish:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Enables distinguishing different types of data objects, subject to the individual API endpoint</span><br/> |
| <kbd><b>from:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, compile data from this timestamp onwards</span><br/> |
| <kbd><b>collapse:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widgets, this collapses sources based on a regex</span><br/> |
| <kbd><b>source:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, only compile data on this specific sourceID</span><br/> |
| <kbd><b>unique:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Only compile data from unique commits, ignore duplicates</span><br/> |
| </pre> |
| </blockquote></div> |
| <br/> |
| <div style='float: left; width: 90%;'><h4>Input examples:</h4><blockquote><pre style='width: 600px;'><b>application/json</b>: |
| { |
| "interval": "month", |
| "quick": false, |
| "to": 1503483273, |
| "span": 2, |
| "types": [ |
| "jira", |
| "bugzilla" |
| ], |
| "view": "abcdef12345678", |
| "distinguish": false, |
| "from": 1400000000, |
| "source": "abcdef12345678" |
| }</pre></blockquote> |
| </div> |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| { |
| "timeseries": [ |
| { |
| "date": 1508273, |
| "$item": 50, |
| "$otheritem": 26 |
| } |
| ] |
| }</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="get-api-code-pony" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #61affe; font-family: sans-serif; background: #61affe30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #61affe;">GET</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/code/pony</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Shows pony factor data for a set of repos over a given period of time</div> |
| <div style="float: left; width: 90%;display: none; "> |
| <h4>JSON parameters:</h4> |
| |
| <br/> |
| |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| { |
| "factors": [ |
| {} |
| ] |
| }</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="post-api-code-pony" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #49cc5c; font-family: sans-serif; background: #49cc5c30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #49cc5c;">POST</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/code/pony</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Shows pony factor data for a set of repos over a given period of time</div> |
| <div style="float: left; width: 90%;display: block; "> |
| <h4>JSON parameters:</h4> |
| <div style='float: left; width: 90%;'><blockquote><pre style='width: 600px;'><kbd><b>quick:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Turns on quick data for some endpoints, returning only sparse data (thus less traffic)</span><br/> |
| <kbd><b>to:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, only compile data up until here</span><br/> |
| <kbd><b>view:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>ID Of optional view to use</span><br/> |
| <kbd><b>sources:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widget, this fetches all sources</span><br/> |
| <kbd><b>author:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Turns on author view for code results, as opposed to the default committer view</span><br/> |
| <kbd><b>interval:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If fetching histograms, this specifies the interval to pack figures into. Can be day, week, month, quarter or year</span><br/> |
| <kbd><b>subfilter:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Quickly defined view by sub-filtering the existing view and matching on sourceURLs</span><br/> |
| <kbd><b>email:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>filter sources based on an email (a person)</span><br/> |
| <kbd><b>links:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for relationship maps, this denotes the minimum link strength (no. of connections) that makes up a link.</span><br/> |
| <kbd><b>search:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widgets, this enables sub-filtering based on searches</span><br/> |
| <kbd><b>types:</b></kbd> (array) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If set, only return data from sources matching these types</span><br/> |
| <kbd><b>span:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>For factor charts, denotes the number of months to base factors on from</span><br/> |
| <kbd><b>distinguish:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Enables distinguishing different types of data objects, subject to the individual API endpoint</span><br/> |
| <kbd><b>from:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, compile data from this timestamp onwards</span><br/> |
| <kbd><b>collapse:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widgets, this collapses sources based on a regex</span><br/> |
| <kbd><b>source:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, only compile data on this specific sourceID</span><br/> |
| <kbd><b>unique:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Only compile data from unique commits, ignore duplicates</span><br/> |
| </pre> |
| </blockquote></div> |
| <br/> |
| <div style='float: left; width: 90%;'><h4>Input examples:</h4><blockquote><pre style='width: 600px;'><b>application/json</b>: |
| { |
| "interval": "month", |
| "quick": false, |
| "to": 1503483273, |
| "span": 2, |
| "types": [ |
| "jira", |
| "bugzilla" |
| ], |
| "view": "abcdef12345678", |
| "distinguish": false, |
| "from": 1400000000, |
| "source": "abcdef12345678" |
| }</pre></blockquote> |
| </div> |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| { |
| "factors": [ |
| {} |
| ] |
| }</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="get-api-code-pony-timeseries" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #61affe; font-family: sans-serif; background: #61affe30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #61affe;">GET</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/code/pony-timeseries</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Shows timeseries of Pony Factor over time</div> |
| <div style="float: left; width: 90%;display: none; "> |
| <h4>JSON parameters:</h4> |
| |
| <br/> |
| |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| { |
| "timeseries": [ |
| { |
| "date": 1508273, |
| "$item": 50, |
| "$otheritem": 26 |
| } |
| ] |
| }</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="post-api-code-pony-timeseries" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #49cc5c; font-family: sans-serif; background: #49cc5c30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #49cc5c;">POST</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/code/pony-timeseries</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Shows timeseries of Pony Factor over time</div> |
| <div style="float: left; width: 90%;display: block; "> |
| <h4>JSON parameters:</h4> |
| <div style='float: left; width: 90%;'><blockquote><pre style='width: 600px;'><kbd><b>quick:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Turns on quick data for some endpoints, returning only sparse data (thus less traffic)</span><br/> |
| <kbd><b>to:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, only compile data up until here</span><br/> |
| <kbd><b>view:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>ID Of optional view to use</span><br/> |
| <kbd><b>sources:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widget, this fetches all sources</span><br/> |
| <kbd><b>author:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Turns on author view for code results, as opposed to the default committer view</span><br/> |
| <kbd><b>interval:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If fetching histograms, this specifies the interval to pack figures into. Can be day, week, month, quarter or year</span><br/> |
| <kbd><b>subfilter:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Quickly defined view by sub-filtering the existing view and matching on sourceURLs</span><br/> |
| <kbd><b>email:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>filter sources based on an email (a person)</span><br/> |
| <kbd><b>links:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for relationship maps, this denotes the minimum link strength (no. of connections) that makes up a link.</span><br/> |
| <kbd><b>search:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widgets, this enables sub-filtering based on searches</span><br/> |
| <kbd><b>types:</b></kbd> (array) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If set, only return data from sources matching these types</span><br/> |
| <kbd><b>span:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>For factor charts, denotes the number of months to base factors on from</span><br/> |
| <kbd><b>distinguish:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Enables distinguishing different types of data objects, subject to the individual API endpoint</span><br/> |
| <kbd><b>from:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, compile data from this timestamp onwards</span><br/> |
| <kbd><b>collapse:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widgets, this collapses sources based on a regex</span><br/> |
| <kbd><b>source:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, only compile data on this specific sourceID</span><br/> |
| <kbd><b>unique:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Only compile data from unique commits, ignore duplicates</span><br/> |
| </pre> |
| </blockquote></div> |
| <br/> |
| <div style='float: left; width: 90%;'><h4>Input examples:</h4><blockquote><pre style='width: 600px;'><b>application/json</b>: |
| { |
| "interval": "month", |
| "quick": false, |
| "to": 1503483273, |
| "span": 2, |
| "types": [ |
| "jira", |
| "bugzilla" |
| ], |
| "view": "abcdef12345678", |
| "distinguish": false, |
| "from": 1400000000, |
| "source": "abcdef12345678" |
| }</pre></blockquote> |
| </div> |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| { |
| "timeseries": [ |
| { |
| "date": 1508273, |
| "$item": 50, |
| "$otheritem": 26 |
| } |
| ] |
| }</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="get-api-code-relationships" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #61affe; font-family: sans-serif; background: #61affe30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #61affe;">GET</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/code/relationships</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Shows a breakdown of contributor relationships between repositories</div> |
| <div style="float: left; width: 90%;display: none; "> |
| <h4>JSON parameters:</h4> |
| |
| <br/> |
| |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| {}</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="post-api-code-relationships" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #49cc5c; font-family: sans-serif; background: #49cc5c30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #49cc5c;">POST</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/code/relationships</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Shows a breakdown of contributor relationships between repositories</div> |
| <div style="float: left; width: 90%;display: block; "> |
| <h4>JSON parameters:</h4> |
| <div style='float: left; width: 90%;'><blockquote><pre style='width: 600px;'><kbd><b>quick:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Turns on quick data for some endpoints, returning only sparse data (thus less traffic)</span><br/> |
| <kbd><b>to:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, only compile data up until here</span><br/> |
| <kbd><b>view:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>ID Of optional view to use</span><br/> |
| <kbd><b>sources:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widget, this fetches all sources</span><br/> |
| <kbd><b>author:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Turns on author view for code results, as opposed to the default committer view</span><br/> |
| <kbd><b>interval:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If fetching histograms, this specifies the interval to pack figures into. Can be day, week, month, quarter or year</span><br/> |
| <kbd><b>subfilter:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Quickly defined view by sub-filtering the existing view and matching on sourceURLs</span><br/> |
| <kbd><b>email:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>filter sources based on an email (a person)</span><br/> |
| <kbd><b>links:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for relationship maps, this denotes the minimum link strength (no. of connections) that makes up a link.</span><br/> |
| <kbd><b>search:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widgets, this enables sub-filtering based on searches</span><br/> |
| <kbd><b>types:</b></kbd> (array) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If set, only return data from sources matching these types</span><br/> |
| <kbd><b>span:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>For factor charts, denotes the number of months to base factors on from</span><br/> |
| <kbd><b>distinguish:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Enables distinguishing different types of data objects, subject to the individual API endpoint</span><br/> |
| <kbd><b>from:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, compile data from this timestamp onwards</span><br/> |
| <kbd><b>collapse:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widgets, this collapses sources based on a regex</span><br/> |
| <kbd><b>source:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, only compile data on this specific sourceID</span><br/> |
| <kbd><b>unique:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Only compile data from unique commits, ignore duplicates</span><br/> |
| </pre> |
| </blockquote></div> |
| <br/> |
| <div style='float: left; width: 90%;'><h4>Input examples:</h4><blockquote><pre style='width: 600px;'><b>application/json</b>: |
| { |
| "interval": "month", |
| "quick": false, |
| "to": 1503483273, |
| "span": 2, |
| "types": [ |
| "jira", |
| "bugzilla" |
| ], |
| "view": "abcdef12345678", |
| "distinguish": false, |
| "from": 1400000000, |
| "source": "abcdef12345678" |
| }</pre></blockquote> |
| </div> |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| {}</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="get-api-code-retention" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #61affe; font-family: sans-serif; background: #61affe30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #61affe;">GET</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/code/retention</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Shows retention metrics for a set of repos over a given period of time</div> |
| <div style="float: left; width: 90%;display: none; "> |
| <h4>JSON parameters:</h4> |
| |
| <br/> |
| |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| { |
| "factors": [ |
| {} |
| ] |
| }</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="post-api-code-retention" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #49cc5c; font-family: sans-serif; background: #49cc5c30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #49cc5c;">POST</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/code/retention</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Shows retention metrics for a set of repos over a given period of time</div> |
| <div style="float: left; width: 90%;display: block; "> |
| <h4>JSON parameters:</h4> |
| <div style='float: left; width: 90%;'><blockquote><pre style='width: 600px;'><kbd><b>quick:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Turns on quick data for some endpoints, returning only sparse data (thus less traffic)</span><br/> |
| <kbd><b>to:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, only compile data up until here</span><br/> |
| <kbd><b>view:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>ID Of optional view to use</span><br/> |
| <kbd><b>sources:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widget, this fetches all sources</span><br/> |
| <kbd><b>author:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Turns on author view for code results, as opposed to the default committer view</span><br/> |
| <kbd><b>interval:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If fetching histograms, this specifies the interval to pack figures into. Can be day, week, month, quarter or year</span><br/> |
| <kbd><b>subfilter:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Quickly defined view by sub-filtering the existing view and matching on sourceURLs</span><br/> |
| <kbd><b>email:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>filter sources based on an email (a person)</span><br/> |
| <kbd><b>links:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for relationship maps, this denotes the minimum link strength (no. of connections) that makes up a link.</span><br/> |
| <kbd><b>search:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widgets, this enables sub-filtering based on searches</span><br/> |
| <kbd><b>types:</b></kbd> (array) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If set, only return data from sources matching these types</span><br/> |
| <kbd><b>span:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>For factor charts, denotes the number of months to base factors on from</span><br/> |
| <kbd><b>distinguish:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Enables distinguishing different types of data objects, subject to the individual API endpoint</span><br/> |
| <kbd><b>from:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, compile data from this timestamp onwards</span><br/> |
| <kbd><b>collapse:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widgets, this collapses sources based on a regex</span><br/> |
| <kbd><b>source:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, only compile data on this specific sourceID</span><br/> |
| <kbd><b>unique:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Only compile data from unique commits, ignore duplicates</span><br/> |
| </pre> |
| </blockquote></div> |
| <br/> |
| <div style='float: left; width: 90%;'><h4>Input examples:</h4><blockquote><pre style='width: 600px;'><b>application/json</b>: |
| { |
| "interval": "month", |
| "quick": false, |
| "to": 1503483273, |
| "span": 2, |
| "types": [ |
| "jira", |
| "bugzilla" |
| ], |
| "view": "abcdef12345678", |
| "distinguish": false, |
| "from": 1400000000, |
| "source": "abcdef12345678" |
| }</pre></blockquote> |
| </div> |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| { |
| "factors": [ |
| {} |
| ] |
| }</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="get-api-code-sloc" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #61affe; font-family: sans-serif; background: #61affe30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #61affe;">GET</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/code/sloc</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Shows a breakdown of lines of code for one or more sources</div> |
| <div style="float: left; width: 90%;display: none; "> |
| <h4>JSON parameters:</h4> |
| |
| <br/> |
| |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| {}</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="post-api-code-sloc" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #49cc5c; font-family: sans-serif; background: #49cc5c30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #49cc5c;">POST</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/code/sloc</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Shows a breakdown of lines of code for one or more sources</div> |
| <div style="float: left; width: 90%;display: block; "> |
| <h4>JSON parameters:</h4> |
| <div style='float: left; width: 90%;'><blockquote><pre style='width: 600px;'><kbd><b>quick:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Turns on quick data for some endpoints, returning only sparse data (thus less traffic)</span><br/> |
| <kbd><b>to:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, only compile data up until here</span><br/> |
| <kbd><b>view:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>ID Of optional view to use</span><br/> |
| <kbd><b>sources:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widget, this fetches all sources</span><br/> |
| <kbd><b>author:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Turns on author view for code results, as opposed to the default committer view</span><br/> |
| <kbd><b>interval:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If fetching histograms, this specifies the interval to pack figures into. Can be day, week, month, quarter or year</span><br/> |
| <kbd><b>subfilter:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Quickly defined view by sub-filtering the existing view and matching on sourceURLs</span><br/> |
| <kbd><b>email:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>filter sources based on an email (a person)</span><br/> |
| <kbd><b>links:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for relationship maps, this denotes the minimum link strength (no. of connections) that makes up a link.</span><br/> |
| <kbd><b>search:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widgets, this enables sub-filtering based on searches</span><br/> |
| <kbd><b>types:</b></kbd> (array) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If set, only return data from sources matching these types</span><br/> |
| <kbd><b>span:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>For factor charts, denotes the number of months to base factors on from</span><br/> |
| <kbd><b>distinguish:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Enables distinguishing different types of data objects, subject to the individual API endpoint</span><br/> |
| <kbd><b>from:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, compile data from this timestamp onwards</span><br/> |
| <kbd><b>collapse:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widgets, this collapses sources based on a regex</span><br/> |
| <kbd><b>source:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, only compile data on this specific sourceID</span><br/> |
| <kbd><b>unique:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Only compile data from unique commits, ignore duplicates</span><br/> |
| </pre> |
| </blockquote></div> |
| <br/> |
| <div style='float: left; width: 90%;'><h4>Input examples:</h4><blockquote><pre style='width: 600px;'><b>application/json</b>: |
| { |
| "interval": "month", |
| "quick": false, |
| "to": 1503483273, |
| "span": 2, |
| "types": [ |
| "jira", |
| "bugzilla" |
| ], |
| "view": "abcdef12345678", |
| "distinguish": false, |
| "from": 1400000000, |
| "source": "abcdef12345678" |
| }</pre></blockquote> |
| </div> |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| {}</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="get-api-code-top-commits" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #61affe; font-family: sans-serif; background: #61affe30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #61affe;">GET</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/code/top-commits</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Shows top 25 repos by commit volume</div> |
| <div style="float: left; width: 90%;display: none; "> |
| <h4>JSON parameters:</h4> |
| |
| <br/> |
| |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| { |
| "timeseries": [ |
| { |
| "date": 1508273, |
| "$item": 50, |
| "$otheritem": 26 |
| } |
| ] |
| }</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="post-api-code-top-commits" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #49cc5c; font-family: sans-serif; background: #49cc5c30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #49cc5c;">POST</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/code/top-commits</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Shows top 25 repos by commit volume</div> |
| <div style="float: left; width: 90%;display: block; "> |
| <h4>JSON parameters:</h4> |
| <div style='float: left; width: 90%;'><blockquote><pre style='width: 600px;'><kbd><b>quick:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Turns on quick data for some endpoints, returning only sparse data (thus less traffic)</span><br/> |
| <kbd><b>to:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, only compile data up until here</span><br/> |
| <kbd><b>view:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>ID Of optional view to use</span><br/> |
| <kbd><b>sources:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widget, this fetches all sources</span><br/> |
| <kbd><b>author:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Turns on author view for code results, as opposed to the default committer view</span><br/> |
| <kbd><b>interval:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If fetching histograms, this specifies the interval to pack figures into. Can be day, week, month, quarter or year</span><br/> |
| <kbd><b>subfilter:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Quickly defined view by sub-filtering the existing view and matching on sourceURLs</span><br/> |
| <kbd><b>email:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>filter sources based on an email (a person)</span><br/> |
| <kbd><b>links:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for relationship maps, this denotes the minimum link strength (no. of connections) that makes up a link.</span><br/> |
| <kbd><b>search:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widgets, this enables sub-filtering based on searches</span><br/> |
| <kbd><b>types:</b></kbd> (array) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If set, only return data from sources matching these types</span><br/> |
| <kbd><b>span:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>For factor charts, denotes the number of months to base factors on from</span><br/> |
| <kbd><b>distinguish:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Enables distinguishing different types of data objects, subject to the individual API endpoint</span><br/> |
| <kbd><b>from:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, compile data from this timestamp onwards</span><br/> |
| <kbd><b>collapse:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widgets, this collapses sources based on a regex</span><br/> |
| <kbd><b>source:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, only compile data on this specific sourceID</span><br/> |
| <kbd><b>unique:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Only compile data from unique commits, ignore duplicates</span><br/> |
| </pre> |
| </blockquote></div> |
| <br/> |
| <div style='float: left; width: 90%;'><h4>Input examples:</h4><blockquote><pre style='width: 600px;'><b>application/json</b>: |
| { |
| "interval": "month", |
| "quick": false, |
| "to": 1503483273, |
| "span": 2, |
| "types": [ |
| "jira", |
| "bugzilla" |
| ], |
| "view": "abcdef12345678", |
| "distinguish": false, |
| "from": 1400000000, |
| "source": "abcdef12345678" |
| }</pre></blockquote> |
| </div> |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| { |
| "timeseries": [ |
| { |
| "date": 1508273, |
| "$item": 50, |
| "$otheritem": 26 |
| } |
| ] |
| }</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="get-api-code-top-sloc" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #61affe; font-family: sans-serif; background: #61affe30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #61affe;">GET</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/code/top-sloc</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Shows top 25 repos by lines of code</div> |
| <div style="float: left; width: 90%;display: none; "> |
| <h4>JSON parameters:</h4> |
| |
| <br/> |
| |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| { |
| "timeseries": [ |
| { |
| "date": 1508273, |
| "$item": 50, |
| "$otheritem": 26 |
| } |
| ] |
| }</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="post-api-code-top-sloc" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #49cc5c; font-family: sans-serif; background: #49cc5c30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #49cc5c;">POST</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/code/top-sloc</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Shows top 25 repos by lines of code</div> |
| <div style="float: left; width: 90%;display: block; "> |
| <h4>JSON parameters:</h4> |
| <div style='float: left; width: 90%;'><blockquote><pre style='width: 600px;'><kbd><b>quick:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Turns on quick data for some endpoints, returning only sparse data (thus less traffic)</span><br/> |
| <kbd><b>to:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, only compile data up until here</span><br/> |
| <kbd><b>view:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>ID Of optional view to use</span><br/> |
| <kbd><b>sources:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widget, this fetches all sources</span><br/> |
| <kbd><b>author:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Turns on author view for code results, as opposed to the default committer view</span><br/> |
| <kbd><b>interval:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If fetching histograms, this specifies the interval to pack figures into. Can be day, week, month, quarter or year</span><br/> |
| <kbd><b>subfilter:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Quickly defined view by sub-filtering the existing view and matching on sourceURLs</span><br/> |
| <kbd><b>email:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>filter sources based on an email (a person)</span><br/> |
| <kbd><b>links:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for relationship maps, this denotes the minimum link strength (no. of connections) that makes up a link.</span><br/> |
| <kbd><b>search:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widgets, this enables sub-filtering based on searches</span><br/> |
| <kbd><b>types:</b></kbd> (array) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If set, only return data from sources matching these types</span><br/> |
| <kbd><b>span:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>For factor charts, denotes the number of months to base factors on from</span><br/> |
| <kbd><b>distinguish:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Enables distinguishing different types of data objects, subject to the individual API endpoint</span><br/> |
| <kbd><b>from:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, compile data from this timestamp onwards</span><br/> |
| <kbd><b>collapse:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widgets, this collapses sources based on a regex</span><br/> |
| <kbd><b>source:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, only compile data on this specific sourceID</span><br/> |
| <kbd><b>unique:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Only compile data from unique commits, ignore duplicates</span><br/> |
| </pre> |
| </blockquote></div> |
| <br/> |
| <div style='float: left; width: 90%;'><h4>Input examples:</h4><blockquote><pre style='width: 600px;'><b>application/json</b>: |
| { |
| "interval": "month", |
| "quick": false, |
| "to": 1503483273, |
| "span": 2, |
| "types": [ |
| "jira", |
| "bugzilla" |
| ], |
| "view": "abcdef12345678", |
| "distinguish": false, |
| "from": 1400000000, |
| "source": "abcdef12345678" |
| }</pre></blockquote> |
| </div> |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| { |
| "timeseries": [ |
| { |
| "date": 1508273, |
| "$item": 50, |
| "$otheritem": 26 |
| } |
| ] |
| }</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="get-api-code-trends" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #61affe; font-family: sans-serif; background: #61affe30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #61affe;">GET</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/code/trends</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Shows trend data for a set of repos over a given period of time</div> |
| <div style="float: left; width: 90%;display: none; "> |
| <h4>JSON parameters:</h4> |
| |
| <br/> |
| |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| {}</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="post-api-code-trends" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #49cc5c; font-family: sans-serif; background: #49cc5c30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #49cc5c;">POST</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/code/trends</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Shows trend data for a set of repos over a given period of time</div> |
| <div style="float: left; width: 90%;display: block; "> |
| <h4>JSON parameters:</h4> |
| <div style='float: left; width: 90%;'><blockquote><pre style='width: 600px;'><kbd><b>quick:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Turns on quick data for some endpoints, returning only sparse data (thus less traffic)</span><br/> |
| <kbd><b>to:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, only compile data up until here</span><br/> |
| <kbd><b>view:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>ID Of optional view to use</span><br/> |
| <kbd><b>sources:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widget, this fetches all sources</span><br/> |
| <kbd><b>author:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Turns on author view for code results, as opposed to the default committer view</span><br/> |
| <kbd><b>interval:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If fetching histograms, this specifies the interval to pack figures into. Can be day, week, month, quarter or year</span><br/> |
| <kbd><b>subfilter:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Quickly defined view by sub-filtering the existing view and matching on sourceURLs</span><br/> |
| <kbd><b>email:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>filter sources based on an email (a person)</span><br/> |
| <kbd><b>links:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for relationship maps, this denotes the minimum link strength (no. of connections) that makes up a link.</span><br/> |
| <kbd><b>search:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widgets, this enables sub-filtering based on searches</span><br/> |
| <kbd><b>types:</b></kbd> (array) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If set, only return data from sources matching these types</span><br/> |
| <kbd><b>span:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>For factor charts, denotes the number of months to base factors on from</span><br/> |
| <kbd><b>distinguish:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Enables distinguishing different types of data objects, subject to the individual API endpoint</span><br/> |
| <kbd><b>from:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, compile data from this timestamp onwards</span><br/> |
| <kbd><b>collapse:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widgets, this collapses sources based on a regex</span><br/> |
| <kbd><b>source:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, only compile data on this specific sourceID</span><br/> |
| <kbd><b>unique:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Only compile data from unique commits, ignore duplicates</span><br/> |
| </pre> |
| </blockquote></div> |
| <br/> |
| <div style='float: left; width: 90%;'><h4>Input examples:</h4><blockquote><pre style='width: 600px;'><b>application/json</b>: |
| { |
| "interval": "month", |
| "quick": false, |
| "to": 1503483273, |
| "span": 2, |
| "types": [ |
| "jira", |
| "bugzilla" |
| ], |
| "view": "abcdef12345678", |
| "distinguish": false, |
| "from": 1400000000, |
| "source": "abcdef12345678" |
| }</pre></blockquote> |
| </div> |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| {}</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="get-api-issue-actors" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #61affe; font-family: sans-serif; background: #61affe30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #61affe;">GET</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/issue/actors</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Shows timeseries of no. of people opening/closing issues over time</div> |
| <div style="float: left; width: 90%;display: none; "> |
| <h4>JSON parameters:</h4> |
| |
| <br/> |
| |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| { |
| "timeseries": [ |
| { |
| "date": 1508273, |
| "$item": 50, |
| "$otheritem": 26 |
| } |
| ] |
| }</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="post-api-issue-actors" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #49cc5c; font-family: sans-serif; background: #49cc5c30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #49cc5c;">POST</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/issue/actors</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Shows timeseries of no. of people opening/closing issues over time</div> |
| <div style="float: left; width: 90%;display: block; "> |
| <h4>JSON parameters:</h4> |
| <div style='float: left; width: 90%;'><blockquote><pre style='width: 600px;'><kbd><b>quick:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Turns on quick data for some endpoints, returning only sparse data (thus less traffic)</span><br/> |
| <kbd><b>to:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, only compile data up until here</span><br/> |
| <kbd><b>view:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>ID Of optional view to use</span><br/> |
| <kbd><b>sources:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widget, this fetches all sources</span><br/> |
| <kbd><b>author:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Turns on author view for code results, as opposed to the default committer view</span><br/> |
| <kbd><b>interval:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If fetching histograms, this specifies the interval to pack figures into. Can be day, week, month, quarter or year</span><br/> |
| <kbd><b>subfilter:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Quickly defined view by sub-filtering the existing view and matching on sourceURLs</span><br/> |
| <kbd><b>email:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>filter sources based on an email (a person)</span><br/> |
| <kbd><b>links:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for relationship maps, this denotes the minimum link strength (no. of connections) that makes up a link.</span><br/> |
| <kbd><b>search:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widgets, this enables sub-filtering based on searches</span><br/> |
| <kbd><b>types:</b></kbd> (array) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If set, only return data from sources matching these types</span><br/> |
| <kbd><b>span:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>For factor charts, denotes the number of months to base factors on from</span><br/> |
| <kbd><b>distinguish:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Enables distinguishing different types of data objects, subject to the individual API endpoint</span><br/> |
| <kbd><b>from:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, compile data from this timestamp onwards</span><br/> |
| <kbd><b>collapse:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widgets, this collapses sources based on a regex</span><br/> |
| <kbd><b>source:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, only compile data on this specific sourceID</span><br/> |
| <kbd><b>unique:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Only compile data from unique commits, ignore duplicates</span><br/> |
| </pre> |
| </blockquote></div> |
| <br/> |
| <div style='float: left; width: 90%;'><h4>Input examples:</h4><blockquote><pre style='width: 600px;'><b>application/json</b>: |
| { |
| "interval": "month", |
| "quick": false, |
| "to": 1503483273, |
| "span": 2, |
| "types": [ |
| "jira", |
| "bugzilla" |
| ], |
| "view": "abcdef12345678", |
| "distinguish": false, |
| "from": 1400000000, |
| "source": "abcdef12345678" |
| }</pre></blockquote> |
| </div> |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| { |
| "timeseries": [ |
| { |
| "date": 1508273, |
| "$item": 50, |
| "$otheritem": 26 |
| } |
| ] |
| }</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="get-api-issue-age" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #61affe; font-family: sans-serif; background: #61affe30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #61affe;">GET</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/issue/age</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Shows timeseries of no. of open tickets by age</div> |
| <div style="float: left; width: 90%;display: none; "> |
| <h4>JSON parameters:</h4> |
| |
| <br/> |
| |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| { |
| "timeseries": [ |
| { |
| "date": 1508273, |
| "$item": 50, |
| "$otheritem": 26 |
| } |
| ] |
| }</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="post-api-issue-age" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #49cc5c; font-family: sans-serif; background: #49cc5c30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #49cc5c;">POST</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/issue/age</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Shows timeseries of no. of open tickets by age</div> |
| <div style="float: left; width: 90%;display: block; "> |
| <h4>JSON parameters:</h4> |
| <div style='float: left; width: 90%;'><blockquote><pre style='width: 600px;'><kbd><b>quick:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Turns on quick data for some endpoints, returning only sparse data (thus less traffic)</span><br/> |
| <kbd><b>to:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, only compile data up until here</span><br/> |
| <kbd><b>view:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>ID Of optional view to use</span><br/> |
| <kbd><b>sources:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widget, this fetches all sources</span><br/> |
| <kbd><b>author:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Turns on author view for code results, as opposed to the default committer view</span><br/> |
| <kbd><b>interval:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If fetching histograms, this specifies the interval to pack figures into. Can be day, week, month, quarter or year</span><br/> |
| <kbd><b>subfilter:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Quickly defined view by sub-filtering the existing view and matching on sourceURLs</span><br/> |
| <kbd><b>email:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>filter sources based on an email (a person)</span><br/> |
| <kbd><b>links:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for relationship maps, this denotes the minimum link strength (no. of connections) that makes up a link.</span><br/> |
| <kbd><b>search:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widgets, this enables sub-filtering based on searches</span><br/> |
| <kbd><b>types:</b></kbd> (array) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If set, only return data from sources matching these types</span><br/> |
| <kbd><b>span:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>For factor charts, denotes the number of months to base factors on from</span><br/> |
| <kbd><b>distinguish:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Enables distinguishing different types of data objects, subject to the individual API endpoint</span><br/> |
| <kbd><b>from:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, compile data from this timestamp onwards</span><br/> |
| <kbd><b>collapse:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widgets, this collapses sources based on a regex</span><br/> |
| <kbd><b>source:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, only compile data on this specific sourceID</span><br/> |
| <kbd><b>unique:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Only compile data from unique commits, ignore duplicates</span><br/> |
| </pre> |
| </blockquote></div> |
| <br/> |
| <div style='float: left; width: 90%;'><h4>Input examples:</h4><blockquote><pre style='width: 600px;'><b>application/json</b>: |
| { |
| "interval": "month", |
| "quick": false, |
| "to": 1503483273, |
| "span": 2, |
| "types": [ |
| "jira", |
| "bugzilla" |
| ], |
| "view": "abcdef12345678", |
| "distinguish": false, |
| "from": 1400000000, |
| "source": "abcdef12345678" |
| }</pre></blockquote> |
| </div> |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| { |
| "timeseries": [ |
| { |
| "date": 1508273, |
| "$item": 50, |
| "$otheritem": 26 |
| } |
| ] |
| }</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="get-api-issue-closers" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #61affe; font-family: sans-serif; background: #61affe30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #61affe;">GET</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/issue/closers</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Shows the top N of issue closers</div> |
| <div style="float: left; width: 90%;display: none; "> |
| <h4>JSON parameters:</h4> |
| |
| <br/> |
| |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| {}</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="post-api-issue-closers" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #49cc5c; font-family: sans-serif; background: #49cc5c30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #49cc5c;">POST</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/issue/closers</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Shows the top N of issue closers</div> |
| <div style="float: left; width: 90%;display: block; "> |
| <h4>JSON parameters:</h4> |
| <div style='float: left; width: 90%;'><blockquote><pre style='width: 600px;'><kbd><b>quick:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Turns on quick data for some endpoints, returning only sparse data (thus less traffic)</span><br/> |
| <kbd><b>to:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, only compile data up until here</span><br/> |
| <kbd><b>view:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>ID Of optional view to use</span><br/> |
| <kbd><b>sources:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widget, this fetches all sources</span><br/> |
| <kbd><b>author:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Turns on author view for code results, as opposed to the default committer view</span><br/> |
| <kbd><b>interval:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If fetching histograms, this specifies the interval to pack figures into. Can be day, week, month, quarter or year</span><br/> |
| <kbd><b>subfilter:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Quickly defined view by sub-filtering the existing view and matching on sourceURLs</span><br/> |
| <kbd><b>email:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>filter sources based on an email (a person)</span><br/> |
| <kbd><b>links:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for relationship maps, this denotes the minimum link strength (no. of connections) that makes up a link.</span><br/> |
| <kbd><b>search:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widgets, this enables sub-filtering based on searches</span><br/> |
| <kbd><b>types:</b></kbd> (array) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If set, only return data from sources matching these types</span><br/> |
| <kbd><b>span:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>For factor charts, denotes the number of months to base factors on from</span><br/> |
| <kbd><b>distinguish:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Enables distinguishing different types of data objects, subject to the individual API endpoint</span><br/> |
| <kbd><b>from:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, compile data from this timestamp onwards</span><br/> |
| <kbd><b>collapse:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widgets, this collapses sources based on a regex</span><br/> |
| <kbd><b>source:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, only compile data on this specific sourceID</span><br/> |
| <kbd><b>unique:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Only compile data from unique commits, ignore duplicates</span><br/> |
| </pre> |
| </blockquote></div> |
| <br/> |
| <div style='float: left; width: 90%;'><h4>Input examples:</h4><blockquote><pre style='width: 600px;'><b>application/json</b>: |
| { |
| "interval": "month", |
| "quick": false, |
| "to": 1503483273, |
| "span": 2, |
| "types": [ |
| "jira", |
| "bugzilla" |
| ], |
| "view": "abcdef12345678", |
| "distinguish": false, |
| "from": 1400000000, |
| "source": "abcdef12345678" |
| }</pre></blockquote> |
| </div> |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| {}</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="get-api-issue-issues" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #61affe; font-family: sans-serif; background: #61affe30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #61affe;">GET</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/issue/issues</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Shows timeseries of issues opened/closed over time</div> |
| <div style="float: left; width: 90%;display: none; "> |
| <h4>JSON parameters:</h4> |
| |
| <br/> |
| |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| { |
| "timeseries": [ |
| { |
| "date": 1508273, |
| "$item": 50, |
| "$otheritem": 26 |
| } |
| ] |
| }</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="post-api-issue-issues" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #49cc5c; font-family: sans-serif; background: #49cc5c30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #49cc5c;">POST</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/issue/issues</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Shows timeseries of issues opened/closed over time</div> |
| <div style="float: left; width: 90%;display: block; "> |
| <h4>JSON parameters:</h4> |
| <div style='float: left; width: 90%;'><blockquote><pre style='width: 600px;'><kbd><b>quick:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Turns on quick data for some endpoints, returning only sparse data (thus less traffic)</span><br/> |
| <kbd><b>to:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, only compile data up until here</span><br/> |
| <kbd><b>view:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>ID Of optional view to use</span><br/> |
| <kbd><b>sources:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widget, this fetches all sources</span><br/> |
| <kbd><b>author:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Turns on author view for code results, as opposed to the default committer view</span><br/> |
| <kbd><b>interval:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If fetching histograms, this specifies the interval to pack figures into. Can be day, week, month, quarter or year</span><br/> |
| <kbd><b>subfilter:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Quickly defined view by sub-filtering the existing view and matching on sourceURLs</span><br/> |
| <kbd><b>email:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>filter sources based on an email (a person)</span><br/> |
| <kbd><b>links:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for relationship maps, this denotes the minimum link strength (no. of connections) that makes up a link.</span><br/> |
| <kbd><b>search:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widgets, this enables sub-filtering based on searches</span><br/> |
| <kbd><b>types:</b></kbd> (array) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If set, only return data from sources matching these types</span><br/> |
| <kbd><b>span:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>For factor charts, denotes the number of months to base factors on from</span><br/> |
| <kbd><b>distinguish:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Enables distinguishing different types of data objects, subject to the individual API endpoint</span><br/> |
| <kbd><b>from:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, compile data from this timestamp onwards</span><br/> |
| <kbd><b>collapse:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widgets, this collapses sources based on a regex</span><br/> |
| <kbd><b>source:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, only compile data on this specific sourceID</span><br/> |
| <kbd><b>unique:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Only compile data from unique commits, ignore duplicates</span><br/> |
| </pre> |
| </blockquote></div> |
| <br/> |
| <div style='float: left; width: 90%;'><h4>Input examples:</h4><blockquote><pre style='width: 600px;'><b>application/json</b>: |
| { |
| "interval": "month", |
| "quick": false, |
| "to": 1503483273, |
| "span": 2, |
| "types": [ |
| "jira", |
| "bugzilla" |
| ], |
| "view": "abcdef12345678", |
| "distinguish": false, |
| "from": 1400000000, |
| "source": "abcdef12345678" |
| }</pre></blockquote> |
| </div> |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| { |
| "timeseries": [ |
| { |
| "date": 1508273, |
| "$item": 50, |
| "$otheritem": 26 |
| } |
| ] |
| }</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="get-api-issue-openers" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #61affe; font-family: sans-serif; background: #61affe30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #61affe;">GET</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/issue/openers</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Shows the top N of issue openers</div> |
| <div style="float: left; width: 90%;display: none; "> |
| <h4>JSON parameters:</h4> |
| |
| <br/> |
| |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| {}</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="post-api-issue-openers" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #49cc5c; font-family: sans-serif; background: #49cc5c30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #49cc5c;">POST</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/issue/openers</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Shows the top N of issue openers</div> |
| <div style="float: left; width: 90%;display: block; "> |
| <h4>JSON parameters:</h4> |
| <div style='float: left; width: 90%;'><blockquote><pre style='width: 600px;'><kbd><b>quick:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Turns on quick data for some endpoints, returning only sparse data (thus less traffic)</span><br/> |
| <kbd><b>to:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, only compile data up until here</span><br/> |
| <kbd><b>view:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>ID Of optional view to use</span><br/> |
| <kbd><b>sources:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widget, this fetches all sources</span><br/> |
| <kbd><b>author:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Turns on author view for code results, as opposed to the default committer view</span><br/> |
| <kbd><b>interval:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If fetching histograms, this specifies the interval to pack figures into. Can be day, week, month, quarter or year</span><br/> |
| <kbd><b>subfilter:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Quickly defined view by sub-filtering the existing view and matching on sourceURLs</span><br/> |
| <kbd><b>email:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>filter sources based on an email (a person)</span><br/> |
| <kbd><b>links:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for relationship maps, this denotes the minimum link strength (no. of connections) that makes up a link.</span><br/> |
| <kbd><b>search:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widgets, this enables sub-filtering based on searches</span><br/> |
| <kbd><b>types:</b></kbd> (array) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If set, only return data from sources matching these types</span><br/> |
| <kbd><b>span:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>For factor charts, denotes the number of months to base factors on from</span><br/> |
| <kbd><b>distinguish:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Enables distinguishing different types of data objects, subject to the individual API endpoint</span><br/> |
| <kbd><b>from:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, compile data from this timestamp onwards</span><br/> |
| <kbd><b>collapse:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widgets, this collapses sources based on a regex</span><br/> |
| <kbd><b>source:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, only compile data on this specific sourceID</span><br/> |
| <kbd><b>unique:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Only compile data from unique commits, ignore duplicates</span><br/> |
| </pre> |
| </blockquote></div> |
| <br/> |
| <div style='float: left; width: 90%;'><h4>Input examples:</h4><blockquote><pre style='width: 600px;'><b>application/json</b>: |
| { |
| "interval": "month", |
| "quick": false, |
| "to": 1503483273, |
| "span": 2, |
| "types": [ |
| "jira", |
| "bugzilla" |
| ], |
| "view": "abcdef12345678", |
| "distinguish": false, |
| "from": 1400000000, |
| "source": "abcdef12345678" |
| }</pre></blockquote> |
| </div> |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| {}</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="get-api-issue-pony-timeseries" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #61affe; font-family: sans-serif; background: #61affe30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #61affe;">GET</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/issue/pony-timeseries</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Shows timeseries of Pony Factor over time</div> |
| <div style="float: left; width: 90%;display: none; "> |
| <h4>JSON parameters:</h4> |
| |
| <br/> |
| |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| { |
| "timeseries": [ |
| { |
| "date": 1508273, |
| "$item": 50, |
| "$otheritem": 26 |
| } |
| ] |
| }</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="post-api-issue-pony-timeseries" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #49cc5c; font-family: sans-serif; background: #49cc5c30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #49cc5c;">POST</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/issue/pony-timeseries</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Shows timeseries of Pony Factor over time</div> |
| <div style="float: left; width: 90%;display: block; "> |
| <h4>JSON parameters:</h4> |
| <div style='float: left; width: 90%;'><blockquote><pre style='width: 600px;'><kbd><b>quick:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Turns on quick data for some endpoints, returning only sparse data (thus less traffic)</span><br/> |
| <kbd><b>to:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, only compile data up until here</span><br/> |
| <kbd><b>view:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>ID Of optional view to use</span><br/> |
| <kbd><b>sources:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widget, this fetches all sources</span><br/> |
| <kbd><b>author:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Turns on author view for code results, as opposed to the default committer view</span><br/> |
| <kbd><b>interval:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If fetching histograms, this specifies the interval to pack figures into. Can be day, week, month, quarter or year</span><br/> |
| <kbd><b>subfilter:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Quickly defined view by sub-filtering the existing view and matching on sourceURLs</span><br/> |
| <kbd><b>email:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>filter sources based on an email (a person)</span><br/> |
| <kbd><b>links:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for relationship maps, this denotes the minimum link strength (no. of connections) that makes up a link.</span><br/> |
| <kbd><b>search:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widgets, this enables sub-filtering based on searches</span><br/> |
| <kbd><b>types:</b></kbd> (array) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If set, only return data from sources matching these types</span><br/> |
| <kbd><b>span:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>For factor charts, denotes the number of months to base factors on from</span><br/> |
| <kbd><b>distinguish:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Enables distinguishing different types of data objects, subject to the individual API endpoint</span><br/> |
| <kbd><b>from:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, compile data from this timestamp onwards</span><br/> |
| <kbd><b>collapse:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widgets, this collapses sources based on a regex</span><br/> |
| <kbd><b>source:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, only compile data on this specific sourceID</span><br/> |
| <kbd><b>unique:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Only compile data from unique commits, ignore duplicates</span><br/> |
| </pre> |
| </blockquote></div> |
| <br/> |
| <div style='float: left; width: 90%;'><h4>Input examples:</h4><blockquote><pre style='width: 600px;'><b>application/json</b>: |
| { |
| "interval": "month", |
| "quick": false, |
| "to": 1503483273, |
| "span": 2, |
| "types": [ |
| "jira", |
| "bugzilla" |
| ], |
| "view": "abcdef12345678", |
| "distinguish": false, |
| "from": 1400000000, |
| "source": "abcdef12345678" |
| }</pre></blockquote> |
| </div> |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| { |
| "timeseries": [ |
| { |
| "date": 1508273, |
| "$item": 50, |
| "$otheritem": 26 |
| } |
| ] |
| }</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="get-api-issue-relationships" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #61affe; font-family: sans-serif; background: #61affe30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #61affe;">GET</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/issue/relationships</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Shows a breakdown of contributor relationships between issue trackers</div> |
| <div style="float: left; width: 90%;display: none; "> |
| <h4>JSON parameters:</h4> |
| |
| <br/> |
| |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| {}</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="post-api-issue-relationships" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #49cc5c; font-family: sans-serif; background: #49cc5c30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #49cc5c;">POST</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/issue/relationships</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Shows a breakdown of contributor relationships between issue trackers</div> |
| <div style="float: left; width: 90%;display: block; "> |
| <h4>JSON parameters:</h4> |
| <div style='float: left; width: 90%;'><blockquote><pre style='width: 600px;'><kbd><b>quick:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Turns on quick data for some endpoints, returning only sparse data (thus less traffic)</span><br/> |
| <kbd><b>to:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, only compile data up until here</span><br/> |
| <kbd><b>view:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>ID Of optional view to use</span><br/> |
| <kbd><b>sources:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widget, this fetches all sources</span><br/> |
| <kbd><b>author:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Turns on author view for code results, as opposed to the default committer view</span><br/> |
| <kbd><b>interval:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If fetching histograms, this specifies the interval to pack figures into. Can be day, week, month, quarter or year</span><br/> |
| <kbd><b>subfilter:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Quickly defined view by sub-filtering the existing view and matching on sourceURLs</span><br/> |
| <kbd><b>email:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>filter sources based on an email (a person)</span><br/> |
| <kbd><b>links:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for relationship maps, this denotes the minimum link strength (no. of connections) that makes up a link.</span><br/> |
| <kbd><b>search:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widgets, this enables sub-filtering based on searches</span><br/> |
| <kbd><b>types:</b></kbd> (array) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If set, only return data from sources matching these types</span><br/> |
| <kbd><b>span:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>For factor charts, denotes the number of months to base factors on from</span><br/> |
| <kbd><b>distinguish:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Enables distinguishing different types of data objects, subject to the individual API endpoint</span><br/> |
| <kbd><b>from:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, compile data from this timestamp onwards</span><br/> |
| <kbd><b>collapse:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widgets, this collapses sources based on a regex</span><br/> |
| <kbd><b>source:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, only compile data on this specific sourceID</span><br/> |
| <kbd><b>unique:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Only compile data from unique commits, ignore duplicates</span><br/> |
| </pre> |
| </blockquote></div> |
| <br/> |
| <div style='float: left; width: 90%;'><h4>Input examples:</h4><blockquote><pre style='width: 600px;'><b>application/json</b>: |
| { |
| "interval": "month", |
| "quick": false, |
| "to": 1503483273, |
| "span": 2, |
| "types": [ |
| "jira", |
| "bugzilla" |
| ], |
| "view": "abcdef12345678", |
| "distinguish": false, |
| "from": 1400000000, |
| "source": "abcdef12345678" |
| }</pre></blockquote> |
| </div> |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| {}</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="get-api-issue-retention" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #61affe; font-family: sans-serif; background: #61affe30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #61affe;">GET</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/issue/retention</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Shows retention metrics for a set of issue trackers over a given period of time</div> |
| <div style="float: left; width: 90%;display: none; "> |
| <h4>JSON parameters:</h4> |
| |
| <br/> |
| |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| { |
| "factors": [ |
| {} |
| ] |
| }</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="post-api-issue-retention" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #49cc5c; font-family: sans-serif; background: #49cc5c30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #49cc5c;">POST</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/issue/retention</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Shows retention metrics for a set of issue trackers over a given period of time</div> |
| <div style="float: left; width: 90%;display: block; "> |
| <h4>JSON parameters:</h4> |
| <div style='float: left; width: 90%;'><blockquote><pre style='width: 600px;'><kbd><b>quick:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Turns on quick data for some endpoints, returning only sparse data (thus less traffic)</span><br/> |
| <kbd><b>to:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, only compile data up until here</span><br/> |
| <kbd><b>view:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>ID Of optional view to use</span><br/> |
| <kbd><b>sources:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widget, this fetches all sources</span><br/> |
| <kbd><b>author:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Turns on author view for code results, as opposed to the default committer view</span><br/> |
| <kbd><b>interval:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If fetching histograms, this specifies the interval to pack figures into. Can be day, week, month, quarter or year</span><br/> |
| <kbd><b>subfilter:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Quickly defined view by sub-filtering the existing view and matching on sourceURLs</span><br/> |
| <kbd><b>email:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>filter sources based on an email (a person)</span><br/> |
| <kbd><b>links:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for relationship maps, this denotes the minimum link strength (no. of connections) that makes up a link.</span><br/> |
| <kbd><b>search:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widgets, this enables sub-filtering based on searches</span><br/> |
| <kbd><b>types:</b></kbd> (array) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If set, only return data from sources matching these types</span><br/> |
| <kbd><b>span:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>For factor charts, denotes the number of months to base factors on from</span><br/> |
| <kbd><b>distinguish:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Enables distinguishing different types of data objects, subject to the individual API endpoint</span><br/> |
| <kbd><b>from:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, compile data from this timestamp onwards</span><br/> |
| <kbd><b>collapse:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widgets, this collapses sources based on a regex</span><br/> |
| <kbd><b>source:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, only compile data on this specific sourceID</span><br/> |
| <kbd><b>unique:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Only compile data from unique commits, ignore duplicates</span><br/> |
| </pre> |
| </blockquote></div> |
| <br/> |
| <div style='float: left; width: 90%;'><h4>Input examples:</h4><blockquote><pre style='width: 600px;'><b>application/json</b>: |
| { |
| "interval": "month", |
| "quick": false, |
| "to": 1503483273, |
| "span": 2, |
| "types": [ |
| "jira", |
| "bugzilla" |
| ], |
| "view": "abcdef12345678", |
| "distinguish": false, |
| "from": 1400000000, |
| "source": "abcdef12345678" |
| }</pre></blockquote> |
| </div> |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| { |
| "factors": [ |
| {} |
| ] |
| }</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="get-api-issue-top" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #61affe; font-family: sans-serif; background: #61affe30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #61affe;">GET</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/issue/top</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Shows the top N issues by interactions</div> |
| <div style="float: left; width: 90%;display: none; "> |
| <h4>JSON parameters:</h4> |
| |
| <br/> |
| |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| { |
| "top": [ |
| {} |
| ] |
| }</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="post-api-issue-top" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #49cc5c; font-family: sans-serif; background: #49cc5c30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #49cc5c;">POST</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/issue/top</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Shows the top N issues by interactions</div> |
| <div style="float: left; width: 90%;display: block; "> |
| <h4>JSON parameters:</h4> |
| <div style='float: left; width: 90%;'><blockquote><pre style='width: 600px;'><kbd><b>quick:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Turns on quick data for some endpoints, returning only sparse data (thus less traffic)</span><br/> |
| <kbd><b>to:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, only compile data up until here</span><br/> |
| <kbd><b>view:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>ID Of optional view to use</span><br/> |
| <kbd><b>sources:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widget, this fetches all sources</span><br/> |
| <kbd><b>author:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Turns on author view for code results, as opposed to the default committer view</span><br/> |
| <kbd><b>interval:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If fetching histograms, this specifies the interval to pack figures into. Can be day, week, month, quarter or year</span><br/> |
| <kbd><b>subfilter:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Quickly defined view by sub-filtering the existing view and matching on sourceURLs</span><br/> |
| <kbd><b>email:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>filter sources based on an email (a person)</span><br/> |
| <kbd><b>links:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for relationship maps, this denotes the minimum link strength (no. of connections) that makes up a link.</span><br/> |
| <kbd><b>search:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widgets, this enables sub-filtering based on searches</span><br/> |
| <kbd><b>types:</b></kbd> (array) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If set, only return data from sources matching these types</span><br/> |
| <kbd><b>span:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>For factor charts, denotes the number of months to base factors on from</span><br/> |
| <kbd><b>distinguish:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Enables distinguishing different types of data objects, subject to the individual API endpoint</span><br/> |
| <kbd><b>from:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, compile data from this timestamp onwards</span><br/> |
| <kbd><b>collapse:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widgets, this collapses sources based on a regex</span><br/> |
| <kbd><b>source:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, only compile data on this specific sourceID</span><br/> |
| <kbd><b>unique:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Only compile data from unique commits, ignore duplicates</span><br/> |
| </pre> |
| </blockquote></div> |
| <br/> |
| <div style='float: left; width: 90%;'><h4>Input examples:</h4><blockquote><pre style='width: 600px;'><b>application/json</b>: |
| { |
| "interval": "month", |
| "quick": false, |
| "to": 1503483273, |
| "span": 2, |
| "types": [ |
| "jira", |
| "bugzilla" |
| ], |
| "view": "abcdef12345678", |
| "distinguish": false, |
| "from": 1400000000, |
| "source": "abcdef12345678" |
| }</pre></blockquote> |
| </div> |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| { |
| "top": [ |
| {} |
| ] |
| }</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="get-api-issue-top-count" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #61affe; font-family: sans-serif; background: #61affe30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #61affe;">GET</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/issue/top-count</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Shows top 25 issue trackers by issues</div> |
| <div style="float: left; width: 90%;display: none; "> |
| <h4>JSON parameters:</h4> |
| |
| <br/> |
| |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| { |
| "timeseries": [ |
| { |
| "date": 1508273, |
| "$item": 50, |
| "$otheritem": 26 |
| } |
| ] |
| }</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="post-api-issue-top-count" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #49cc5c; font-family: sans-serif; background: #49cc5c30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #49cc5c;">POST</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/issue/top-count</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Shows top 25 issue trackers by issues</div> |
| <div style="float: left; width: 90%;display: block; "> |
| <h4>JSON parameters:</h4> |
| <div style='float: left; width: 90%;'><blockquote><pre style='width: 600px;'><kbd><b>quick:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Turns on quick data for some endpoints, returning only sparse data (thus less traffic)</span><br/> |
| <kbd><b>to:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, only compile data up until here</span><br/> |
| <kbd><b>view:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>ID Of optional view to use</span><br/> |
| <kbd><b>sources:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widget, this fetches all sources</span><br/> |
| <kbd><b>author:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Turns on author view for code results, as opposed to the default committer view</span><br/> |
| <kbd><b>interval:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If fetching histograms, this specifies the interval to pack figures into. Can be day, week, month, quarter or year</span><br/> |
| <kbd><b>subfilter:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Quickly defined view by sub-filtering the existing view and matching on sourceURLs</span><br/> |
| <kbd><b>email:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>filter sources based on an email (a person)</span><br/> |
| <kbd><b>links:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for relationship maps, this denotes the minimum link strength (no. of connections) that makes up a link.</span><br/> |
| <kbd><b>search:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widgets, this enables sub-filtering based on searches</span><br/> |
| <kbd><b>types:</b></kbd> (array) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If set, only return data from sources matching these types</span><br/> |
| <kbd><b>span:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>For factor charts, denotes the number of months to base factors on from</span><br/> |
| <kbd><b>distinguish:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Enables distinguishing different types of data objects, subject to the individual API endpoint</span><br/> |
| <kbd><b>from:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, compile data from this timestamp onwards</span><br/> |
| <kbd><b>collapse:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widgets, this collapses sources based on a regex</span><br/> |
| <kbd><b>source:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, only compile data on this specific sourceID</span><br/> |
| <kbd><b>unique:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Only compile data from unique commits, ignore duplicates</span><br/> |
| </pre> |
| </blockquote></div> |
| <br/> |
| <div style='float: left; width: 90%;'><h4>Input examples:</h4><blockquote><pre style='width: 600px;'><b>application/json</b>: |
| { |
| "interval": "month", |
| "quick": false, |
| "to": 1503483273, |
| "span": 2, |
| "types": [ |
| "jira", |
| "bugzilla" |
| ], |
| "view": "abcdef12345678", |
| "distinguish": false, |
| "from": 1400000000, |
| "source": "abcdef12345678" |
| }</pre></blockquote> |
| </div> |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| { |
| "timeseries": [ |
| { |
| "date": 1508273, |
| "$item": 50, |
| "$otheritem": 26 |
| } |
| ] |
| }</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="get-api-issue-trends" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #61affe; font-family: sans-serif; background: #61affe30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #61affe;">GET</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/issue/trends</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Shows trend data for a set of issue trackers over a given period of time</div> |
| <div style="float: left; width: 90%;display: none; "> |
| <h4>JSON parameters:</h4> |
| |
| <br/> |
| |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| {}</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="post-api-issue-trends" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #49cc5c; font-family: sans-serif; background: #49cc5c30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #49cc5c;">POST</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/issue/trends</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Shows trend data for a set of issue trackers over a given period of time</div> |
| <div style="float: left; width: 90%;display: block; "> |
| <h4>JSON parameters:</h4> |
| <div style='float: left; width: 90%;'><blockquote><pre style='width: 600px;'><kbd><b>quick:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Turns on quick data for some endpoints, returning only sparse data (thus less traffic)</span><br/> |
| <kbd><b>to:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, only compile data up until here</span><br/> |
| <kbd><b>view:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>ID Of optional view to use</span><br/> |
| <kbd><b>sources:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widget, this fetches all sources</span><br/> |
| <kbd><b>author:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Turns on author view for code results, as opposed to the default committer view</span><br/> |
| <kbd><b>interval:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If fetching histograms, this specifies the interval to pack figures into. Can be day, week, month, quarter or year</span><br/> |
| <kbd><b>subfilter:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Quickly defined view by sub-filtering the existing view and matching on sourceURLs</span><br/> |
| <kbd><b>email:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>filter sources based on an email (a person)</span><br/> |
| <kbd><b>links:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for relationship maps, this denotes the minimum link strength (no. of connections) that makes up a link.</span><br/> |
| <kbd><b>search:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widgets, this enables sub-filtering based on searches</span><br/> |
| <kbd><b>types:</b></kbd> (array) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If set, only return data from sources matching these types</span><br/> |
| <kbd><b>span:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>For factor charts, denotes the number of months to base factors on from</span><br/> |
| <kbd><b>distinguish:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Enables distinguishing different types of data objects, subject to the individual API endpoint</span><br/> |
| <kbd><b>from:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, compile data from this timestamp onwards</span><br/> |
| <kbd><b>collapse:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widgets, this collapses sources based on a regex</span><br/> |
| <kbd><b>source:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, only compile data on this specific sourceID</span><br/> |
| <kbd><b>unique:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Only compile data from unique commits, ignore duplicates</span><br/> |
| </pre> |
| </blockquote></div> |
| <br/> |
| <div style='float: left; width: 90%;'><h4>Input examples:</h4><blockquote><pre style='width: 600px;'><b>application/json</b>: |
| { |
| "interval": "month", |
| "quick": false, |
| "to": 1503483273, |
| "span": 2, |
| "types": [ |
| "jira", |
| "bugzilla" |
| ], |
| "view": "abcdef12345678", |
| "distinguish": false, |
| "from": 1400000000, |
| "source": "abcdef12345678" |
| }</pre></blockquote> |
| </div> |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| {}</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="get-api-mail-map" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #61affe; font-family: sans-serif; background: #61affe30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #61affe;">GET</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/mail/map</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Shows a breakdown of email author reply mappings</div> |
| <div style="float: left; width: 90%;display: none; "> |
| <h4>JSON parameters:</h4> |
| |
| <br/> |
| |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| {}</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="post-api-mail-map" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #49cc5c; font-family: sans-serif; background: #49cc5c30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #49cc5c;">POST</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/mail/map</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Shows a breakdown of email author reply mappings</div> |
| <div style="float: left; width: 90%;display: block; "> |
| <h4>JSON parameters:</h4> |
| <div style='float: left; width: 90%;'><blockquote><pre style='width: 600px;'><kbd><b>quick:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Turns on quick data for some endpoints, returning only sparse data (thus less traffic)</span><br/> |
| <kbd><b>to:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, only compile data up until here</span><br/> |
| <kbd><b>view:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>ID Of optional view to use</span><br/> |
| <kbd><b>sources:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widget, this fetches all sources</span><br/> |
| <kbd><b>author:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Turns on author view for code results, as opposed to the default committer view</span><br/> |
| <kbd><b>interval:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If fetching histograms, this specifies the interval to pack figures into. Can be day, week, month, quarter or year</span><br/> |
| <kbd><b>subfilter:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Quickly defined view by sub-filtering the existing view and matching on sourceURLs</span><br/> |
| <kbd><b>email:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>filter sources based on an email (a person)</span><br/> |
| <kbd><b>links:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for relationship maps, this denotes the minimum link strength (no. of connections) that makes up a link.</span><br/> |
| <kbd><b>search:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widgets, this enables sub-filtering based on searches</span><br/> |
| <kbd><b>types:</b></kbd> (array) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If set, only return data from sources matching these types</span><br/> |
| <kbd><b>span:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>For factor charts, denotes the number of months to base factors on from</span><br/> |
| <kbd><b>distinguish:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Enables distinguishing different types of data objects, subject to the individual API endpoint</span><br/> |
| <kbd><b>from:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, compile data from this timestamp onwards</span><br/> |
| <kbd><b>collapse:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widgets, this collapses sources based on a regex</span><br/> |
| <kbd><b>source:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, only compile data on this specific sourceID</span><br/> |
| <kbd><b>unique:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Only compile data from unique commits, ignore duplicates</span><br/> |
| </pre> |
| </blockquote></div> |
| <br/> |
| <div style='float: left; width: 90%;'><h4>Input examples:</h4><blockquote><pre style='width: 600px;'><b>application/json</b>: |
| { |
| "interval": "month", |
| "quick": false, |
| "to": 1503483273, |
| "span": 2, |
| "types": [ |
| "jira", |
| "bugzilla" |
| ], |
| "view": "abcdef12345678", |
| "distinguish": false, |
| "from": 1400000000, |
| "source": "abcdef12345678" |
| }</pre></blockquote> |
| </div> |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| {}</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="get-api-mail-pony-timeseries" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #61affe; font-family: sans-serif; background: #61affe30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #61affe;">GET</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/mail/pony-timeseries</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Shows timeseries of Pony Factor over time</div> |
| <div style="float: left; width: 90%;display: none; "> |
| <h4>JSON parameters:</h4> |
| |
| <br/> |
| |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| { |
| "timeseries": [ |
| { |
| "date": 1508273, |
| "$item": 50, |
| "$otheritem": 26 |
| } |
| ] |
| }</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="post-api-mail-pony-timeseries" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #49cc5c; font-family: sans-serif; background: #49cc5c30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #49cc5c;">POST</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/mail/pony-timeseries</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Shows timeseries of Pony Factor over time</div> |
| <div style="float: left; width: 90%;display: block; "> |
| <h4>JSON parameters:</h4> |
| <div style='float: left; width: 90%;'><blockquote><pre style='width: 600px;'><kbd><b>quick:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Turns on quick data for some endpoints, returning only sparse data (thus less traffic)</span><br/> |
| <kbd><b>to:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, only compile data up until here</span><br/> |
| <kbd><b>view:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>ID Of optional view to use</span><br/> |
| <kbd><b>sources:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widget, this fetches all sources</span><br/> |
| <kbd><b>author:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Turns on author view for code results, as opposed to the default committer view</span><br/> |
| <kbd><b>interval:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If fetching histograms, this specifies the interval to pack figures into. Can be day, week, month, quarter or year</span><br/> |
| <kbd><b>subfilter:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Quickly defined view by sub-filtering the existing view and matching on sourceURLs</span><br/> |
| <kbd><b>email:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>filter sources based on an email (a person)</span><br/> |
| <kbd><b>links:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for relationship maps, this denotes the minimum link strength (no. of connections) that makes up a link.</span><br/> |
| <kbd><b>search:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widgets, this enables sub-filtering based on searches</span><br/> |
| <kbd><b>types:</b></kbd> (array) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If set, only return data from sources matching these types</span><br/> |
| <kbd><b>span:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>For factor charts, denotes the number of months to base factors on from</span><br/> |
| <kbd><b>distinguish:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Enables distinguishing different types of data objects, subject to the individual API endpoint</span><br/> |
| <kbd><b>from:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, compile data from this timestamp onwards</span><br/> |
| <kbd><b>collapse:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widgets, this collapses sources based on a regex</span><br/> |
| <kbd><b>source:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, only compile data on this specific sourceID</span><br/> |
| <kbd><b>unique:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Only compile data from unique commits, ignore duplicates</span><br/> |
| </pre> |
| </blockquote></div> |
| <br/> |
| <div style='float: left; width: 90%;'><h4>Input examples:</h4><blockquote><pre style='width: 600px;'><b>application/json</b>: |
| { |
| "interval": "month", |
| "quick": false, |
| "to": 1503483273, |
| "span": 2, |
| "types": [ |
| "jira", |
| "bugzilla" |
| ], |
| "view": "abcdef12345678", |
| "distinguish": false, |
| "from": 1400000000, |
| "source": "abcdef12345678" |
| }</pre></blockquote> |
| </div> |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| { |
| "timeseries": [ |
| { |
| "date": 1508273, |
| "$item": 50, |
| "$otheritem": 26 |
| } |
| ] |
| }</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="get-api-mail-relationships" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #61affe; font-family: sans-serif; background: #61affe30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #61affe;">GET</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/mail/relationships</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Shows a breakdown of contributor relationships between mailing lists</div> |
| <div style="float: left; width: 90%;display: none; "> |
| <h4>JSON parameters:</h4> |
| |
| <br/> |
| |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| {}</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="post-api-mail-relationships" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #49cc5c; font-family: sans-serif; background: #49cc5c30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #49cc5c;">POST</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/mail/relationships</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Shows a breakdown of contributor relationships between mailing lists</div> |
| <div style="float: left; width: 90%;display: block; "> |
| <h4>JSON parameters:</h4> |
| <div style='float: left; width: 90%;'><blockquote><pre style='width: 600px;'><kbd><b>quick:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Turns on quick data for some endpoints, returning only sparse data (thus less traffic)</span><br/> |
| <kbd><b>to:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, only compile data up until here</span><br/> |
| <kbd><b>view:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>ID Of optional view to use</span><br/> |
| <kbd><b>sources:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widget, this fetches all sources</span><br/> |
| <kbd><b>author:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Turns on author view for code results, as opposed to the default committer view</span><br/> |
| <kbd><b>interval:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If fetching histograms, this specifies the interval to pack figures into. Can be day, week, month, quarter or year</span><br/> |
| <kbd><b>subfilter:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Quickly defined view by sub-filtering the existing view and matching on sourceURLs</span><br/> |
| <kbd><b>email:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>filter sources based on an email (a person)</span><br/> |
| <kbd><b>links:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for relationship maps, this denotes the minimum link strength (no. of connections) that makes up a link.</span><br/> |
| <kbd><b>search:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widgets, this enables sub-filtering based on searches</span><br/> |
| <kbd><b>types:</b></kbd> (array) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If set, only return data from sources matching these types</span><br/> |
| <kbd><b>span:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>For factor charts, denotes the number of months to base factors on from</span><br/> |
| <kbd><b>distinguish:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Enables distinguishing different types of data objects, subject to the individual API endpoint</span><br/> |
| <kbd><b>from:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, compile data from this timestamp onwards</span><br/> |
| <kbd><b>collapse:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widgets, this collapses sources based on a regex</span><br/> |
| <kbd><b>source:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, only compile data on this specific sourceID</span><br/> |
| <kbd><b>unique:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Only compile data from unique commits, ignore duplicates</span><br/> |
| </pre> |
| </blockquote></div> |
| <br/> |
| <div style='float: left; width: 90%;'><h4>Input examples:</h4><blockquote><pre style='width: 600px;'><b>application/json</b>: |
| { |
| "interval": "month", |
| "quick": false, |
| "to": 1503483273, |
| "span": 2, |
| "types": [ |
| "jira", |
| "bugzilla" |
| ], |
| "view": "abcdef12345678", |
| "distinguish": false, |
| "from": 1400000000, |
| "source": "abcdef12345678" |
| }</pre></blockquote> |
| </div> |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| {}</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="get-api-mail-retention" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #61affe; font-family: sans-serif; background: #61affe30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #61affe;">GET</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/mail/retention</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Shows retention metrics for a set of mailing lists over a given period of time</div> |
| <div style="float: left; width: 90%;display: none; "> |
| <h4>JSON parameters:</h4> |
| |
| <br/> |
| |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| { |
| "factors": [ |
| {} |
| ] |
| }</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="post-api-mail-retention" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #49cc5c; font-family: sans-serif; background: #49cc5c30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #49cc5c;">POST</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/mail/retention</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Shows retention metrics for a set of mailing lists over a given period of time</div> |
| <div style="float: left; width: 90%;display: block; "> |
| <h4>JSON parameters:</h4> |
| <div style='float: left; width: 90%;'><blockquote><pre style='width: 600px;'><kbd><b>quick:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Turns on quick data for some endpoints, returning only sparse data (thus less traffic)</span><br/> |
| <kbd><b>to:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, only compile data up until here</span><br/> |
| <kbd><b>view:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>ID Of optional view to use</span><br/> |
| <kbd><b>sources:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widget, this fetches all sources</span><br/> |
| <kbd><b>author:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Turns on author view for code results, as opposed to the default committer view</span><br/> |
| <kbd><b>interval:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If fetching histograms, this specifies the interval to pack figures into. Can be day, week, month, quarter or year</span><br/> |
| <kbd><b>subfilter:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Quickly defined view by sub-filtering the existing view and matching on sourceURLs</span><br/> |
| <kbd><b>email:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>filter sources based on an email (a person)</span><br/> |
| <kbd><b>links:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for relationship maps, this denotes the minimum link strength (no. of connections) that makes up a link.</span><br/> |
| <kbd><b>search:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widgets, this enables sub-filtering based on searches</span><br/> |
| <kbd><b>types:</b></kbd> (array) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If set, only return data from sources matching these types</span><br/> |
| <kbd><b>span:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>For factor charts, denotes the number of months to base factors on from</span><br/> |
| <kbd><b>distinguish:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Enables distinguishing different types of data objects, subject to the individual API endpoint</span><br/> |
| <kbd><b>from:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, compile data from this timestamp onwards</span><br/> |
| <kbd><b>collapse:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widgets, this collapses sources based on a regex</span><br/> |
| <kbd><b>source:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, only compile data on this specific sourceID</span><br/> |
| <kbd><b>unique:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Only compile data from unique commits, ignore duplicates</span><br/> |
| </pre> |
| </blockquote></div> |
| <br/> |
| <div style='float: left; width: 90%;'><h4>Input examples:</h4><blockquote><pre style='width: 600px;'><b>application/json</b>: |
| { |
| "interval": "month", |
| "quick": false, |
| "to": 1503483273, |
| "span": 2, |
| "types": [ |
| "jira", |
| "bugzilla" |
| ], |
| "view": "abcdef12345678", |
| "distinguish": false, |
| "from": 1400000000, |
| "source": "abcdef12345678" |
| }</pre></blockquote> |
| </div> |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| { |
| "factors": [ |
| {} |
| ] |
| }</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="get-api-mail-timeseries" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #61affe; font-family: sans-serif; background: #61affe30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #61affe;">GET</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/mail/timeseries</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Shows email sent over time</div> |
| <div style="float: left; width: 90%;display: none; "> |
| <h4>JSON parameters:</h4> |
| |
| <br/> |
| |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| { |
| "timeseries": [ |
| { |
| "date": 1508273, |
| "$item": 50, |
| "$otheritem": 26 |
| } |
| ] |
| }</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="post-api-mail-timeseries" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #49cc5c; font-family: sans-serif; background: #49cc5c30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #49cc5c;">POST</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/mail/timeseries</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Shows email sent over time</div> |
| <div style="float: left; width: 90%;display: block; "> |
| <h4>JSON parameters:</h4> |
| <div style='float: left; width: 90%;'><blockquote><pre style='width: 600px;'><kbd><b>quick:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Turns on quick data for some endpoints, returning only sparse data (thus less traffic)</span><br/> |
| <kbd><b>to:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, only compile data up until here</span><br/> |
| <kbd><b>view:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>ID Of optional view to use</span><br/> |
| <kbd><b>sources:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widget, this fetches all sources</span><br/> |
| <kbd><b>author:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Turns on author view for code results, as opposed to the default committer view</span><br/> |
| <kbd><b>interval:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If fetching histograms, this specifies the interval to pack figures into. Can be day, week, month, quarter or year</span><br/> |
| <kbd><b>subfilter:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Quickly defined view by sub-filtering the existing view and matching on sourceURLs</span><br/> |
| <kbd><b>email:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>filter sources based on an email (a person)</span><br/> |
| <kbd><b>links:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for relationship maps, this denotes the minimum link strength (no. of connections) that makes up a link.</span><br/> |
| <kbd><b>search:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widgets, this enables sub-filtering based on searches</span><br/> |
| <kbd><b>types:</b></kbd> (array) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If set, only return data from sources matching these types</span><br/> |
| <kbd><b>span:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>For factor charts, denotes the number of months to base factors on from</span><br/> |
| <kbd><b>distinguish:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Enables distinguishing different types of data objects, subject to the individual API endpoint</span><br/> |
| <kbd><b>from:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, compile data from this timestamp onwards</span><br/> |
| <kbd><b>collapse:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widgets, this collapses sources based on a regex</span><br/> |
| <kbd><b>source:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, only compile data on this specific sourceID</span><br/> |
| <kbd><b>unique:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Only compile data from unique commits, ignore duplicates</span><br/> |
| </pre> |
| </blockquote></div> |
| <br/> |
| <div style='float: left; width: 90%;'><h4>Input examples:</h4><blockquote><pre style='width: 600px;'><b>application/json</b>: |
| { |
| "interval": "month", |
| "quick": false, |
| "to": 1503483273, |
| "span": 2, |
| "types": [ |
| "jira", |
| "bugzilla" |
| ], |
| "view": "abcdef12345678", |
| "distinguish": false, |
| "from": 1400000000, |
| "source": "abcdef12345678" |
| }</pre></blockquote> |
| </div> |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| { |
| "timeseries": [ |
| { |
| "date": 1508273, |
| "$item": 50, |
| "$otheritem": 26 |
| } |
| ] |
| }</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="get-api-mail-timeseries-single" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #61affe; font-family: sans-serif; background: #61affe30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #61affe;">GET</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/mail/timeseries-single</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Shows email sent over time</div> |
| <div style="float: left; width: 90%;display: none; "> |
| <h4>JSON parameters:</h4> |
| |
| <br/> |
| |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| { |
| "timeseries": [ |
| { |
| "date": 1508273, |
| "$item": 50, |
| "$otheritem": 26 |
| } |
| ] |
| }</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="post-api-mail-timeseries-single" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #49cc5c; font-family: sans-serif; background: #49cc5c30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #49cc5c;">POST</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/mail/timeseries-single</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Shows email sent over time</div> |
| <div style="float: left; width: 90%;display: block; "> |
| <h4>JSON parameters:</h4> |
| <div style='float: left; width: 90%;'><blockquote><pre style='width: 600px;'><kbd><b>quick:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Turns on quick data for some endpoints, returning only sparse data (thus less traffic)</span><br/> |
| <kbd><b>to:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, only compile data up until here</span><br/> |
| <kbd><b>view:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>ID Of optional view to use</span><br/> |
| <kbd><b>sources:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widget, this fetches all sources</span><br/> |
| <kbd><b>author:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Turns on author view for code results, as opposed to the default committer view</span><br/> |
| <kbd><b>interval:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If fetching histograms, this specifies the interval to pack figures into. Can be day, week, month, quarter or year</span><br/> |
| <kbd><b>subfilter:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Quickly defined view by sub-filtering the existing view and matching on sourceURLs</span><br/> |
| <kbd><b>email:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>filter sources based on an email (a person)</span><br/> |
| <kbd><b>links:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for relationship maps, this denotes the minimum link strength (no. of connections) that makes up a link.</span><br/> |
| <kbd><b>search:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widgets, this enables sub-filtering based on searches</span><br/> |
| <kbd><b>types:</b></kbd> (array) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If set, only return data from sources matching these types</span><br/> |
| <kbd><b>span:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>For factor charts, denotes the number of months to base factors on from</span><br/> |
| <kbd><b>distinguish:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Enables distinguishing different types of data objects, subject to the individual API endpoint</span><br/> |
| <kbd><b>from:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, compile data from this timestamp onwards</span><br/> |
| <kbd><b>collapse:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widgets, this collapses sources based on a regex</span><br/> |
| <kbd><b>source:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, only compile data on this specific sourceID</span><br/> |
| <kbd><b>unique:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Only compile data from unique commits, ignore duplicates</span><br/> |
| </pre> |
| </blockquote></div> |
| <br/> |
| <div style='float: left; width: 90%;'><h4>Input examples:</h4><blockquote><pre style='width: 600px;'><b>application/json</b>: |
| { |
| "interval": "month", |
| "quick": false, |
| "to": 1503483273, |
| "span": 2, |
| "types": [ |
| "jira", |
| "bugzilla" |
| ], |
| "view": "abcdef12345678", |
| "distinguish": false, |
| "from": 1400000000, |
| "source": "abcdef12345678" |
| }</pre></blockquote> |
| </div> |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| { |
| "timeseries": [ |
| { |
| "date": 1508273, |
| "$item": 50, |
| "$otheritem": 26 |
| } |
| ] |
| }</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="get-api-mail-top-authors" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #61affe; font-family: sans-serif; background: #61affe30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #61affe;">GET</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/mail/top-authors</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Shows the top N of email authors</div> |
| <div style="float: left; width: 90%;display: none; "> |
| <h4>JSON parameters:</h4> |
| |
| <br/> |
| |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| {}</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="post-api-mail-top-authors" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #49cc5c; font-family: sans-serif; background: #49cc5c30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #49cc5c;">POST</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/mail/top-authors</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Shows the top N of email authors</div> |
| <div style="float: left; width: 90%;display: block; "> |
| <h4>JSON parameters:</h4> |
| <div style='float: left; width: 90%;'><blockquote><pre style='width: 600px;'><kbd><b>quick:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Turns on quick data for some endpoints, returning only sparse data (thus less traffic)</span><br/> |
| <kbd><b>to:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, only compile data up until here</span><br/> |
| <kbd><b>view:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>ID Of optional view to use</span><br/> |
| <kbd><b>sources:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widget, this fetches all sources</span><br/> |
| <kbd><b>author:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Turns on author view for code results, as opposed to the default committer view</span><br/> |
| <kbd><b>interval:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If fetching histograms, this specifies the interval to pack figures into. Can be day, week, month, quarter or year</span><br/> |
| <kbd><b>subfilter:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Quickly defined view by sub-filtering the existing view and matching on sourceURLs</span><br/> |
| <kbd><b>email:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>filter sources based on an email (a person)</span><br/> |
| <kbd><b>links:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for relationship maps, this denotes the minimum link strength (no. of connections) that makes up a link.</span><br/> |
| <kbd><b>search:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widgets, this enables sub-filtering based on searches</span><br/> |
| <kbd><b>types:</b></kbd> (array) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If set, only return data from sources matching these types</span><br/> |
| <kbd><b>span:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>For factor charts, denotes the number of months to base factors on from</span><br/> |
| <kbd><b>distinguish:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Enables distinguishing different types of data objects, subject to the individual API endpoint</span><br/> |
| <kbd><b>from:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, compile data from this timestamp onwards</span><br/> |
| <kbd><b>collapse:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widgets, this collapses sources based on a regex</span><br/> |
| <kbd><b>source:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, only compile data on this specific sourceID</span><br/> |
| <kbd><b>unique:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Only compile data from unique commits, ignore duplicates</span><br/> |
| </pre> |
| </blockquote></div> |
| <br/> |
| <div style='float: left; width: 90%;'><h4>Input examples:</h4><blockquote><pre style='width: 600px;'><b>application/json</b>: |
| { |
| "interval": "month", |
| "quick": false, |
| "to": 1503483273, |
| "span": 2, |
| "types": [ |
| "jira", |
| "bugzilla" |
| ], |
| "view": "abcdef12345678", |
| "distinguish": false, |
| "from": 1400000000, |
| "source": "abcdef12345678" |
| }</pre></blockquote> |
| </div> |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| {}</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="get-api-mail-top-topics" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #61affe; font-family: sans-serif; background: #61affe30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #61affe;">GET</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/mail/top-topics</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Shows the top N of email authors</div> |
| <div style="float: left; width: 90%;display: none; "> |
| <h4>JSON parameters:</h4> |
| |
| <br/> |
| |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| {}</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="post-api-mail-top-topics" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #49cc5c; font-family: sans-serif; background: #49cc5c30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #49cc5c;">POST</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/mail/top-topics</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Shows the top N of email authors</div> |
| <div style="float: left; width: 90%;display: block; "> |
| <h4>JSON parameters:</h4> |
| <div style='float: left; width: 90%;'><blockquote><pre style='width: 600px;'><kbd><b>quick:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Turns on quick data for some endpoints, returning only sparse data (thus less traffic)</span><br/> |
| <kbd><b>to:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, only compile data up until here</span><br/> |
| <kbd><b>view:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>ID Of optional view to use</span><br/> |
| <kbd><b>sources:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widget, this fetches all sources</span><br/> |
| <kbd><b>author:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Turns on author view for code results, as opposed to the default committer view</span><br/> |
| <kbd><b>interval:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If fetching histograms, this specifies the interval to pack figures into. Can be day, week, month, quarter or year</span><br/> |
| <kbd><b>subfilter:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Quickly defined view by sub-filtering the existing view and matching on sourceURLs</span><br/> |
| <kbd><b>email:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>filter sources based on an email (a person)</span><br/> |
| <kbd><b>links:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for relationship maps, this denotes the minimum link strength (no. of connections) that makes up a link.</span><br/> |
| <kbd><b>search:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widgets, this enables sub-filtering based on searches</span><br/> |
| <kbd><b>types:</b></kbd> (array) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If set, only return data from sources matching these types</span><br/> |
| <kbd><b>span:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>For factor charts, denotes the number of months to base factors on from</span><br/> |
| <kbd><b>distinguish:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Enables distinguishing different types of data objects, subject to the individual API endpoint</span><br/> |
| <kbd><b>from:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, compile data from this timestamp onwards</span><br/> |
| <kbd><b>collapse:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widgets, this collapses sources based on a regex</span><br/> |
| <kbd><b>source:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, only compile data on this specific sourceID</span><br/> |
| <kbd><b>unique:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Only compile data from unique commits, ignore duplicates</span><br/> |
| </pre> |
| </blockquote></div> |
| <br/> |
| <div style='float: left; width: 90%;'><h4>Input examples:</h4><blockquote><pre style='width: 600px;'><b>application/json</b>: |
| { |
| "interval": "month", |
| "quick": false, |
| "to": 1503483273, |
| "span": 2, |
| "types": [ |
| "jira", |
| "bugzilla" |
| ], |
| "view": "abcdef12345678", |
| "distinguish": false, |
| "from": 1400000000, |
| "source": "abcdef12345678" |
| }</pre></blockquote> |
| </div> |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| {}</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="get-api-mail-trends" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #61affe; font-family: sans-serif; background: #61affe30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #61affe;">GET</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/mail/trends</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Shows a quick email trend summary of the past 6 months for your org</div> |
| <div style="float: left; width: 90%;display: none; "> |
| <h4>JSON parameters:</h4> |
| |
| <br/> |
| |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| {}</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="post-api-mail-trends" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #49cc5c; font-family: sans-serif; background: #49cc5c30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #49cc5c;">POST</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/mail/trends</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Shows a quick email trend summary of the past 6 months for your org</div> |
| <div style="float: left; width: 90%;display: block; "> |
| <h4>JSON parameters:</h4> |
| <div style='float: left; width: 90%;'><blockquote><pre style='width: 600px;'><kbd><b>quick:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Turns on quick data for some endpoints, returning only sparse data (thus less traffic)</span><br/> |
| <kbd><b>to:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, only compile data up until here</span><br/> |
| <kbd><b>view:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>ID Of optional view to use</span><br/> |
| <kbd><b>sources:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widget, this fetches all sources</span><br/> |
| <kbd><b>author:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Turns on author view for code results, as opposed to the default committer view</span><br/> |
| <kbd><b>interval:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If fetching histograms, this specifies the interval to pack figures into. Can be day, week, month, quarter or year</span><br/> |
| <kbd><b>subfilter:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Quickly defined view by sub-filtering the existing view and matching on sourceURLs</span><br/> |
| <kbd><b>email:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>filter sources based on an email (a person)</span><br/> |
| <kbd><b>links:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for relationship maps, this denotes the minimum link strength (no. of connections) that makes up a link.</span><br/> |
| <kbd><b>search:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widgets, this enables sub-filtering based on searches</span><br/> |
| <kbd><b>types:</b></kbd> (array) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If set, only return data from sources matching these types</span><br/> |
| <kbd><b>span:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>For factor charts, denotes the number of months to base factors on from</span><br/> |
| <kbd><b>distinguish:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Enables distinguishing different types of data objects, subject to the individual API endpoint</span><br/> |
| <kbd><b>from:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, compile data from this timestamp onwards</span><br/> |
| <kbd><b>collapse:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widgets, this collapses sources based on a regex</span><br/> |
| <kbd><b>source:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, only compile data on this specific sourceID</span><br/> |
| <kbd><b>unique:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Only compile data from unique commits, ignore duplicates</span><br/> |
| </pre> |
| </blockquote></div> |
| <br/> |
| <div style='float: left; width: 90%;'><h4>Input examples:</h4><blockquote><pre style='width: 600px;'><b>application/json</b>: |
| { |
| "interval": "month", |
| "quick": false, |
| "to": 1503483273, |
| "span": 2, |
| "types": [ |
| "jira", |
| "bugzilla" |
| ], |
| "view": "abcdef12345678", |
| "distinguish": false, |
| "from": 1400000000, |
| "source": "abcdef12345678" |
| }</pre></blockquote> |
| </div> |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| {}</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="get-api-org-list" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #61affe; font-family: sans-serif; background: #61affe30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #61affe;">GET</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/org/list</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Lists the organisations you belong to (or all, if admin)</div> |
| <div style="float: left; width: 90%;display: none; "> |
| <h4>JSON parameters:</h4> |
| |
| <br/> |
| |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| {}</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="post-api-org-list" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #49cc5c; font-family: sans-serif; background: #49cc5c30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #49cc5c;">POST</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/org/list</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Lists the organisations you belong to (or all, if admin)</div> |
| <div style="float: left; width: 90%;display: block; "> |
| <h4>JSON parameters:</h4> |
| <div style='float: left; width: 90%;'><blockquote><pre style='width: 600px;'><kbd><b>quick:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Turns on quick data for some endpoints, returning only sparse data (thus less traffic)</span><br/> |
| <kbd><b>to:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, only compile data up until here</span><br/> |
| <kbd><b>view:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>ID Of optional view to use</span><br/> |
| <kbd><b>sources:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widget, this fetches all sources</span><br/> |
| <kbd><b>author:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Turns on author view for code results, as opposed to the default committer view</span><br/> |
| <kbd><b>interval:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If fetching histograms, this specifies the interval to pack figures into. Can be day, week, month, quarter or year</span><br/> |
| <kbd><b>subfilter:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Quickly defined view by sub-filtering the existing view and matching on sourceURLs</span><br/> |
| <kbd><b>email:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>filter sources based on an email (a person)</span><br/> |
| <kbd><b>links:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for relationship maps, this denotes the minimum link strength (no. of connections) that makes up a link.</span><br/> |
| <kbd><b>search:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widgets, this enables sub-filtering based on searches</span><br/> |
| <kbd><b>types:</b></kbd> (array) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If set, only return data from sources matching these types</span><br/> |
| <kbd><b>span:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>For factor charts, denotes the number of months to base factors on from</span><br/> |
| <kbd><b>distinguish:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Enables distinguishing different types of data objects, subject to the individual API endpoint</span><br/> |
| <kbd><b>from:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, compile data from this timestamp onwards</span><br/> |
| <kbd><b>collapse:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widgets, this collapses sources based on a regex</span><br/> |
| <kbd><b>source:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, only compile data on this specific sourceID</span><br/> |
| <kbd><b>unique:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Only compile data from unique commits, ignore duplicates</span><br/> |
| </pre> |
| </blockquote></div> |
| <br/> |
| <div style='float: left; width: 90%;'><h4>Input examples:</h4><blockquote><pre style='width: 600px;'><b>application/json</b>: |
| { |
| "interval": "month", |
| "quick": false, |
| "to": 1503483273, |
| "span": 2, |
| "types": [ |
| "jira", |
| "bugzilla" |
| ], |
| "view": "abcdef12345678", |
| "distinguish": false, |
| "from": 1400000000, |
| "source": "abcdef12345678" |
| }</pre></blockquote> |
| </div> |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| [ |
| { |
| "id": "demo", |
| "sourceCount": 45, |
| "docCount": 973624, |
| "name": "Kibble, Inc.", |
| "description": "demo, inc. is awesome" |
| } |
| ]</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="put-api-org-list" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #fca130; font-family: sans-serif; background: #fca13030;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #fca130;">PUT</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/org/list</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Create a new organisation</div> |
| <div style="float: left; width: 90%;display: block; "> |
| <h4>JSON parameters:</h4> |
| <div style='float: left; width: 90%;'><blockquote><pre style='width: 600px;'><kbd><b>id:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>the ID of the organisation, can be anything.</span><br/> |
| <kbd><b>desc:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>A short description of the organisation</span><br/> |
| <kbd><b>name:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>The name of the organisation to create</span><br/> |
| </pre> |
| </blockquote></div> |
| <br/> |
| <div style='float: left; width: 90%;'><h4>Input examples:</h4><blockquote><pre style='width: 600px;'><b>application/json</b>: |
| { |
| "id": "demo", |
| "desc": "Kibble, inc. is awesome", |
| "name": "Kibble, Inc." |
| }</pre></blockquote> |
| </div> |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| { |
| "message": "Action completed" |
| }</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="delete-api-org-members" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #f93e3e; font-family: sans-serif; background: #f93e3e30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #f93e3e;">DELETE</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/org/members</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Remove a person from an organisation</div> |
| <div style="float: left; width: 90%;display: block; "> |
| <h4>JSON parameters:</h4> |
| <div style='float: left; width: 90%;'><blockquote><pre style='width: 600px;'><kbd><b>password:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Desired password for the account</span><br/> |
| <kbd><b>admin:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>when adding users to orgs, this signifies ownership</span><br/> |
| <kbd><b>displayname:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>A display name (e.g. full name) for the account</span><br/> |
| <kbd><b>email:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Desired username (email address)</span><br/> |
| <kbd><b>defaultOrganisation:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If editing an account, this sets the default org (if a member of it)</span><br/> |
| </pre> |
| </blockquote></div> |
| <br/> |
| <div style='float: left; width: 90%;'><h4>Input examples:</h4><blockquote><pre style='width: 600px;'><b>application/json</b>: |
| { |
| "password": "kibbledemo", |
| "admin": false, |
| "displayname": "Kibble Guest", |
| "email": "guest@kibble.live", |
| "defaultOrganisation": "demo" |
| }</pre></blockquote> |
| </div> |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| { |
| "message": "Action completed" |
| }</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="get-api-org-members" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #61affe; font-family: sans-serif; background: #61affe30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #61affe;">GET</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/org/members</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Lists the members of an organisation</div> |
| <div style="float: left; width: 90%;display: none; "> |
| <h4>JSON parameters:</h4> |
| |
| <br/> |
| |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| {}</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="post-api-org-members" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #49cc5c; font-family: sans-serif; background: #49cc5c30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #49cc5c;">POST</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/org/members</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Lists the members of an organisation</div> |
| <div style="float: left; width: 90%;display: block; "> |
| <h4>JSON parameters:</h4> |
| <div style='float: left; width: 90%;'><blockquote><pre style='width: 600px;'><kbd><b>quick:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Turns on quick data for some endpoints, returning only sparse data (thus less traffic)</span><br/> |
| <kbd><b>to:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, only compile data up until here</span><br/> |
| <kbd><b>view:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>ID Of optional view to use</span><br/> |
| <kbd><b>sources:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widget, this fetches all sources</span><br/> |
| <kbd><b>author:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Turns on author view for code results, as opposed to the default committer view</span><br/> |
| <kbd><b>interval:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If fetching histograms, this specifies the interval to pack figures into. Can be day, week, month, quarter or year</span><br/> |
| <kbd><b>subfilter:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Quickly defined view by sub-filtering the existing view and matching on sourceURLs</span><br/> |
| <kbd><b>email:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>filter sources based on an email (a person)</span><br/> |
| <kbd><b>links:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for relationship maps, this denotes the minimum link strength (no. of connections) that makes up a link.</span><br/> |
| <kbd><b>search:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widgets, this enables sub-filtering based on searches</span><br/> |
| <kbd><b>types:</b></kbd> (array) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If set, only return data from sources matching these types</span><br/> |
| <kbd><b>span:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>For factor charts, denotes the number of months to base factors on from</span><br/> |
| <kbd><b>distinguish:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Enables distinguishing different types of data objects, subject to the individual API endpoint</span><br/> |
| <kbd><b>from:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, compile data from this timestamp onwards</span><br/> |
| <kbd><b>collapse:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widgets, this collapses sources based on a regex</span><br/> |
| <kbd><b>source:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, only compile data on this specific sourceID</span><br/> |
| <kbd><b>unique:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Only compile data from unique commits, ignore duplicates</span><br/> |
| </pre> |
| </blockquote></div> |
| <br/> |
| <div style='float: left; width: 90%;'><h4>Input examples:</h4><blockquote><pre style='width: 600px;'><b>application/json</b>: |
| { |
| "interval": "month", |
| "quick": false, |
| "to": 1503483273, |
| "span": 2, |
| "types": [ |
| "jira", |
| "bugzilla" |
| ], |
| "view": "abcdef12345678", |
| "distinguish": false, |
| "from": 1400000000, |
| "source": "abcdef12345678" |
| }</pre></blockquote> |
| </div> |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| [ |
| {} |
| ]</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="put-api-org-members" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #fca130; font-family: sans-serif; background: #fca13030;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #fca130;">PUT</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/org/members</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Invite a person to an organisation</div> |
| <div style="float: left; width: 90%;display: block; "> |
| <h4>JSON parameters:</h4> |
| <div style='float: left; width: 90%;'><blockquote><pre style='width: 600px;'><kbd><b>password:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Desired password for the account</span><br/> |
| <kbd><b>admin:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>when adding users to orgs, this signifies ownership</span><br/> |
| <kbd><b>displayname:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>A display name (e.g. full name) for the account</span><br/> |
| <kbd><b>email:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Desired username (email address)</span><br/> |
| <kbd><b>defaultOrganisation:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If editing an account, this sets the default org (if a member of it)</span><br/> |
| </pre> |
| </blockquote></div> |
| <br/> |
| <div style='float: left; width: 90%;'><h4>Input examples:</h4><blockquote><pre style='width: 600px;'><b>application/json</b>: |
| { |
| "password": "kibbledemo", |
| "admin": false, |
| "displayname": "Kibble Guest", |
| "email": "guest@kibble.live", |
| "defaultOrganisation": "demo" |
| }</pre></blockquote> |
| </div> |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| { |
| "message": "Action completed" |
| }</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="get-api-org-sourcetypes" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #61affe; font-family: sans-serif; background: #61affe30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #61affe;">GET</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/org/sourcetypes</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Lists the available source types supported by Kibble</div> |
| <div style="float: left; width: 90%;display: none; "> |
| <h4>JSON parameters:</h4> |
| |
| <br/> |
| |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| {}</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="post-api-org-sourcetypes" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #49cc5c; font-family: sans-serif; background: #49cc5c30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #49cc5c;">POST</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/org/sourcetypes</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Lists the available source types supported by Kibble</div> |
| <div style="float: left; width: 90%;display: block; "> |
| <h4>JSON parameters:</h4> |
| <div style='float: left; width: 90%;'><blockquote><pre style='width: 600px;'><kbd><b>quick:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Turns on quick data for some endpoints, returning only sparse data (thus less traffic)</span><br/> |
| <kbd><b>to:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, only compile data up until here</span><br/> |
| <kbd><b>view:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>ID Of optional view to use</span><br/> |
| <kbd><b>sources:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widget, this fetches all sources</span><br/> |
| <kbd><b>author:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Turns on author view for code results, as opposed to the default committer view</span><br/> |
| <kbd><b>interval:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If fetching histograms, this specifies the interval to pack figures into. Can be day, week, month, quarter or year</span><br/> |
| <kbd><b>subfilter:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Quickly defined view by sub-filtering the existing view and matching on sourceURLs</span><br/> |
| <kbd><b>email:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>filter sources based on an email (a person)</span><br/> |
| <kbd><b>links:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for relationship maps, this denotes the minimum link strength (no. of connections) that makes up a link.</span><br/> |
| <kbd><b>search:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widgets, this enables sub-filtering based on searches</span><br/> |
| <kbd><b>types:</b></kbd> (array) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If set, only return data from sources matching these types</span><br/> |
| <kbd><b>span:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>For factor charts, denotes the number of months to base factors on from</span><br/> |
| <kbd><b>distinguish:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Enables distinguishing different types of data objects, subject to the individual API endpoint</span><br/> |
| <kbd><b>from:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, compile data from this timestamp onwards</span><br/> |
| <kbd><b>collapse:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widgets, this collapses sources based on a regex</span><br/> |
| <kbd><b>source:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, only compile data on this specific sourceID</span><br/> |
| <kbd><b>unique:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Only compile data from unique commits, ignore duplicates</span><br/> |
| </pre> |
| </blockquote></div> |
| <br/> |
| <div style='float: left; width: 90%;'><h4>Input examples:</h4><blockquote><pre style='width: 600px;'><b>application/json</b>: |
| { |
| "interval": "month", |
| "quick": false, |
| "to": 1503483273, |
| "span": 2, |
| "types": [ |
| "jira", |
| "bugzilla" |
| ], |
| "view": "abcdef12345678", |
| "distinguish": false, |
| "from": 1400000000, |
| "source": "abcdef12345678" |
| }</pre></blockquote> |
| </div> |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| {}</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="get-api-org-trends" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #61affe; font-family: sans-serif; background: #61affe30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #61affe;">GET</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/org/trends</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Shows a quick trend summary of the past 6 months for your org</div> |
| <div style="float: left; width: 90%;display: none; "> |
| <h4>JSON parameters:</h4> |
| |
| <br/> |
| |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| {}</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="post-api-org-trends" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #49cc5c; font-family: sans-serif; background: #49cc5c30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #49cc5c;">POST</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/org/trends</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Shows a quick trend summary of the past 6 months for your org</div> |
| <div style="float: left; width: 90%;display: block; "> |
| <h4>JSON parameters:</h4> |
| <div style='float: left; width: 90%;'><blockquote><pre style='width: 600px;'><kbd><b>quick:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Turns on quick data for some endpoints, returning only sparse data (thus less traffic)</span><br/> |
| <kbd><b>to:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, only compile data up until here</span><br/> |
| <kbd><b>view:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>ID Of optional view to use</span><br/> |
| <kbd><b>sources:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widget, this fetches all sources</span><br/> |
| <kbd><b>author:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Turns on author view for code results, as opposed to the default committer view</span><br/> |
| <kbd><b>interval:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If fetching histograms, this specifies the interval to pack figures into. Can be day, week, month, quarter or year</span><br/> |
| <kbd><b>subfilter:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Quickly defined view by sub-filtering the existing view and matching on sourceURLs</span><br/> |
| <kbd><b>email:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>filter sources based on an email (a person)</span><br/> |
| <kbd><b>links:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for relationship maps, this denotes the minimum link strength (no. of connections) that makes up a link.</span><br/> |
| <kbd><b>search:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widgets, this enables sub-filtering based on searches</span><br/> |
| <kbd><b>types:</b></kbd> (array) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If set, only return data from sources matching these types</span><br/> |
| <kbd><b>span:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>For factor charts, denotes the number of months to base factors on from</span><br/> |
| <kbd><b>distinguish:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Enables distinguishing different types of data objects, subject to the individual API endpoint</span><br/> |
| <kbd><b>from:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, compile data from this timestamp onwards</span><br/> |
| <kbd><b>collapse:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widgets, this collapses sources based on a regex</span><br/> |
| <kbd><b>source:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, only compile data on this specific sourceID</span><br/> |
| <kbd><b>unique:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Only compile data from unique commits, ignore duplicates</span><br/> |
| </pre> |
| </blockquote></div> |
| <br/> |
| <div style='float: left; width: 90%;'><h4>Input examples:</h4><blockquote><pre style='width: 600px;'><b>application/json</b>: |
| { |
| "interval": "month", |
| "quick": false, |
| "to": 1503483273, |
| "span": 2, |
| "types": [ |
| "jira", |
| "bugzilla" |
| ], |
| "view": "abcdef12345678", |
| "distinguish": false, |
| "from": 1400000000, |
| "source": "abcdef12345678" |
| }</pre></blockquote> |
| </div> |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| {}</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="delete-api-session" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #f93e3e; font-family: sans-serif; background: #f93e3e30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #f93e3e;">DELETE</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/session</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Log out (remove session)</div> |
| <div style="float: left; width: 90%;display: block; "> |
| <h4>JSON parameters:</h4> |
| <div style='float: left; width: 90%;'><blockquote><pre style='width: 600px;'><kbd><b>id:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>optional object ID</span><br/> |
| <kbd><b>page:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>optional page id</span><br/> |
| </pre> |
| </blockquote></div> |
| <br/> |
| <div style='float: left; width: 90%;'><h4>Input examples:</h4><blockquote><pre style='width: 600px;'><b>application/json</b>: |
| {}</pre></blockquote> |
| </div> |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| { |
| "message": "Action completed" |
| }</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="get-api-session" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #61affe; font-family: sans-serif; background: #61affe30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #61affe;">GET</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/session</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Display your login details</div> |
| <div style="float: left; width: 90%;display: none; "> |
| <h4>JSON parameters:</h4> |
| |
| <br/> |
| |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| { |
| "displayName": "Kibble Guest", |
| "defaultOrganisation": "apache", |
| "userLevel": "user", |
| "username": "guest@kibble.live", |
| "organisations": [ |
| "apache", |
| "demo" |
| ] |
| }</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="put-api-session" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #fca130; font-family: sans-serif; background: #fca13030;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #fca130;">PUT</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/session</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Log in</div> |
| <div style="float: left; width: 90%;display: block; "> |
| <h4>JSON parameters:</h4> |
| <div style='float: left; width: 90%;'><blockquote><pre style='width: 600px;'><kbd><b>password:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>User password</span><br/> |
| <kbd><b>email:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Username (email)</span><br/> |
| </pre> |
| </blockquote></div> |
| <br/> |
| <div style='float: left; width: 90%;'><h4>Input examples:</h4><blockquote><pre style='width: 600px;'><b>application/json</b>: |
| { |
| "password": "kibbledemo", |
| "email": "guest@kibble.live" |
| }</pre></blockquote> |
| </div> |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| { |
| "message": "Action completed" |
| }</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="delete-api-sources" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #f93e3e; font-family: sans-serif; background: #f93e3e30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #f93e3e;">DELETE</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/sources</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Delete an existing source</div> |
| <div style="float: left; width: 90%;display: block; "> |
| <h4>JSON parameters:</h4> |
| <div style='float: left; width: 90%;'><blockquote><pre style='width: 600px;'><kbd><b>id:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>source ID</span><br/> |
| </pre> |
| </blockquote></div> |
| <br/> |
| <div style='float: left; width: 90%;'><h4>Input examples:</h4><blockquote><pre style='width: 600px;'><b>application/json</b>: |
| {}</pre></blockquote> |
| </div> |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote></blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="get-api-sources" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #61affe; font-family: sans-serif; background: #61affe30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #61affe;">GET</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/sources</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Fetches a list of all sources for this organisation</div> |
| <div style="float: left; width: 90%;display: none; "> |
| <h4>JSON parameters:</h4> |
| |
| <br/> |
| |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| { |
| "sources": [ |
| {} |
| ] |
| }</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="patch-api-sources" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #d5a37e; font-family: sans-serif; background: #d5a37e30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #d5a37e;">PATCH</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/sources</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Edit an existing source</div> |
| <div style="float: left; width: 90%;display: block; "> |
| <h4>JSON parameters:</h4> |
| <div style='float: left; width: 90%;'><blockquote><pre style='width: 600px;'><kbd><b>sourceID:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>The SourceID of this source</span><br/> |
| <kbd><b>organisation:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>The organisation this source belongs to</span><br/> |
| <kbd><b>password:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>optional password for auth</span><br/> |
| <kbd><b>type:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>The type of source (git, svn, bugzilla, mail, etc)</span><br/> |
| <kbd><b>sourceURL:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>The origin URL of this source.</span><br/> |
| <kbd><b>username:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>optional username for auth</span><br/> |
| <kbd><b>cookie:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>optional session cookie for auth</span><br/> |
| </pre> |
| </blockquote></div> |
| <br/> |
| <div style='float: left; width: 90%;'><h4>Input examples:</h4><blockquote><pre style='width: 600px;'><b>application/json</b>: |
| {}</pre></blockquote> |
| </div> |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| { |
| "message": "Action completed" |
| }</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="post-api-sources" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #49cc5c; font-family: sans-serif; background: #49cc5c30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #49cc5c;">POST</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/sources</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Fetches a list of all sources for this organisation</div> |
| <div style="float: left; width: 90%;display: block; "> |
| <h4>JSON parameters:</h4> |
| <div style='float: left; width: 90%;'><blockquote><pre style='width: 600px;'><kbd><b>quick:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Turns on quick data for some endpoints, returning only sparse data (thus less traffic)</span><br/> |
| <kbd><b>to:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, only compile data up until here</span><br/> |
| <kbd><b>view:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>ID Of optional view to use</span><br/> |
| <kbd><b>sources:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widget, this fetches all sources</span><br/> |
| <kbd><b>author:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Turns on author view for code results, as opposed to the default committer view</span><br/> |
| <kbd><b>interval:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If fetching histograms, this specifies the interval to pack figures into. Can be day, week, month, quarter or year</span><br/> |
| <kbd><b>subfilter:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Quickly defined view by sub-filtering the existing view and matching on sourceURLs</span><br/> |
| <kbd><b>email:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>filter sources based on an email (a person)</span><br/> |
| <kbd><b>links:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for relationship maps, this denotes the minimum link strength (no. of connections) that makes up a link.</span><br/> |
| <kbd><b>search:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widgets, this enables sub-filtering based on searches</span><br/> |
| <kbd><b>types:</b></kbd> (array) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If set, only return data from sources matching these types</span><br/> |
| <kbd><b>span:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>For factor charts, denotes the number of months to base factors on from</span><br/> |
| <kbd><b>distinguish:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Enables distinguishing different types of data objects, subject to the individual API endpoint</span><br/> |
| <kbd><b>from:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, compile data from this timestamp onwards</span><br/> |
| <kbd><b>collapse:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widgets, this collapses sources based on a regex</span><br/> |
| <kbd><b>source:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, only compile data on this specific sourceID</span><br/> |
| <kbd><b>unique:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Only compile data from unique commits, ignore duplicates</span><br/> |
| </pre> |
| </blockquote></div> |
| <br/> |
| <div style='float: left; width: 90%;'><h4>Input examples:</h4><blockquote><pre style='width: 600px;'><b>application/json</b>: |
| { |
| "interval": "month", |
| "quick": false, |
| "to": 1503483273, |
| "span": 2, |
| "types": [ |
| "jira", |
| "bugzilla" |
| ], |
| "view": "abcdef12345678", |
| "distinguish": false, |
| "from": 1400000000, |
| "source": "abcdef12345678" |
| }</pre></blockquote> |
| </div> |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| { |
| "sources": [ |
| {} |
| ] |
| }</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="put-api-sources" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #fca130; font-family: sans-serif; background: #fca13030;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #fca130;">PUT</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/sources</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Add a new source</div> |
| <div style="float: left; width: 90%;display: block; "> |
| <h4>JSON parameters:</h4> |
| <div style='float: left; width: 90%;'><blockquote><pre style='width: 600px;'><kbd><b>sources:</b></kbd> (array) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>The sources in this organisation</span><br/> |
| <kbd><b>organisation:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>The organisation these sources belong to</span><br/> |
| </pre> |
| </blockquote></div> |
| <br/> |
| <div style='float: left; width: 90%;'><h4>Input examples:</h4><blockquote><pre style='width: 600px;'><b>application/json</b>: |
| { |
| "sources": [ |
| {} |
| ] |
| }</pre></blockquote> |
| </div> |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| { |
| "message": "Action completed" |
| }</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="get-api-verify-{email}-{vcode}" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #61affe; font-family: sans-serif; background: #61affe30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #61affe;">GET</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/verify/{email}/{vcode}</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Verify an account</div> |
| <div style="float: left; width: 90%;display: none; "> |
| <h4>JSON parameters:</h4> |
| |
| <br/> |
| |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| { |
| "message": "Action completed" |
| }</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="delete-api-views" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #f93e3e; font-family: sans-serif; background: #f93e3e30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #f93e3e;">DELETE</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/views</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Delete a new view</div> |
| <div style="float: left; width: 90%;display: block; "> |
| <h4>JSON parameters:</h4> |
| |
| <br/> |
| <div style='float: left; width: 90%;'><h4>Input examples:</h4><blockquote><pre style='width: 600px;'><b>application/json</b>: |
| {}</pre></blockquote> |
| </div> |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| { |
| "message": "Action completed" |
| }</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="get-api-views" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #61affe; font-family: sans-serif; background: #61affe30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #61affe;">GET</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/views</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Fetches a list of all views (filters) for this user</div> |
| <div style="float: left; width: 90%;display: none; "> |
| <h4>JSON parameters:</h4> |
| |
| <br/> |
| |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| { |
| "sources": [ |
| {} |
| ], |
| "organisation": "apache", |
| "views": [ |
| { |
| "sources": [ |
| {} |
| ], |
| "id": "abcdef67126734271", |
| "organisation": "apache", |
| "name": "Big Data Projects" |
| } |
| ] |
| }</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="patch-api-views" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #d5a37e; font-family: sans-serif; background: #d5a37e30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #d5a37e;">PATCH</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/views</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Edit an existing source</div> |
| <div style="float: left; width: 90%;display: block; "> |
| <h4>JSON parameters:</h4> |
| |
| <br/> |
| <div style='float: left; width: 90%;'><h4>Input examples:</h4><blockquote><pre style='width: 600px;'><b>application/json</b>: |
| {}</pre></blockquote> |
| </div> |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| { |
| "message": "Action completed" |
| }</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="post-api-views" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #49cc5c; font-family: sans-serif; background: #49cc5c30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #49cc5c;">POST</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/views</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Fetches a list of all views (filters) for this user</div> |
| <div style="float: left; width: 90%;display: block; "> |
| <h4>JSON parameters:</h4> |
| <div style='float: left; width: 90%;'><blockquote><pre style='width: 600px;'><kbd><b>quick:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Turns on quick data for some endpoints, returning only sparse data (thus less traffic)</span><br/> |
| <kbd><b>to:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, only compile data up until here</span><br/> |
| <kbd><b>view:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>ID Of optional view to use</span><br/> |
| <kbd><b>sources:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widget, this fetches all sources</span><br/> |
| <kbd><b>author:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Turns on author view for code results, as opposed to the default committer view</span><br/> |
| <kbd><b>interval:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If fetching histograms, this specifies the interval to pack figures into. Can be day, week, month, quarter or year</span><br/> |
| <kbd><b>subfilter:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Quickly defined view by sub-filtering the existing view and matching on sourceURLs</span><br/> |
| <kbd><b>email:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>filter sources based on an email (a person)</span><br/> |
| <kbd><b>links:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for relationship maps, this denotes the minimum link strength (no. of connections) that makes up a link.</span><br/> |
| <kbd><b>search:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widgets, this enables sub-filtering based on searches</span><br/> |
| <kbd><b>types:</b></kbd> (array) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If set, only return data from sources matching these types</span><br/> |
| <kbd><b>span:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>For factor charts, denotes the number of months to base factors on from</span><br/> |
| <kbd><b>distinguish:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Enables distinguishing different types of data objects, subject to the individual API endpoint</span><br/> |
| <kbd><b>from:</b></kbd> (integer) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, compile data from this timestamp onwards</span><br/> |
| <kbd><b>collapse:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>for some widgets, this collapses sources based on a regex</span><br/> |
| <kbd><b>source:</b></kbd> (string) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>If specified, only compile data on this specific sourceID</span><br/> |
| <kbd><b>unique:</b></kbd> (boolean) <span style='font-size: 12px; font-family: Open Sans, sans-serif;'>Only compile data from unique commits, ignore duplicates</span><br/> |
| </pre> |
| </blockquote></div> |
| <br/> |
| <div style='float: left; width: 90%;'><h4>Input examples:</h4><blockquote><pre style='width: 600px;'><b>application/json</b>: |
| { |
| "interval": "month", |
| "quick": false, |
| "to": 1503483273, |
| "span": 2, |
| "types": [ |
| "jira", |
| "bugzilla" |
| ], |
| "view": "abcdef12345678", |
| "distinguish": false, |
| "from": 1400000000, |
| "source": "abcdef12345678" |
| }</pre></blockquote> |
| </div> |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| { |
| "sources": [ |
| {} |
| ], |
| "organisation": "apache", |
| "views": [ |
| { |
| "sources": [ |
| {} |
| ], |
| "id": "abcdef67126734271", |
| "organisation": "apache", |
| "name": "Big Data Projects" |
| } |
| ] |
| }</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="put-api-views" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #fca130; font-family: sans-serif; background: #fca13030;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #fca130;">PUT</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/views</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Add a new view</div> |
| <div style="float: left; width: 90%;display: block; "> |
| <h4>JSON parameters:</h4> |
| |
| <br/> |
| <div style='float: left; width: 90%;'><h4>Input examples:</h4><blockquote><pre style='width: 600px;'><b>application/json</b>: |
| {}</pre></blockquote> |
| </div> |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| { |
| "message": "Action completed" |
| }</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="get-api-widgets-{pageid}" style="margin: 20px; display: flex; box-sizing: border-box; width: 900px; border-radius: 6px; border: 1px solid #61affe; font-family: sans-serif; background: #61affe30;"> |
| <div style="min-height: 32px;"> |
| <!-- method --> |
| |
| <div style="float: left; align-items: center; margin: 4px; border-radius: 5px; text-align: center; padding-top: 4px; height: 20px; width: 100px; color: #FFF; font-weight: bold; background: #61affe;">GET</div> |
| |
| <!-- path and summary --> |
| <span style="display: flex; padding-top: 6px;"><kbd><strong>/api/widgets/{pageid}</strong></kbd></span> |
| <div style="box-sizing: border-box; flex: 1; font-size: 13px; font-family: Open Sans, sans-serif; float: left; padding-top: 6px; margin-left: 20px;"> |
| Shows the widget layout for a specific page</div> |
| <div style="float: left; width: 90%;display: none; "> |
| <h4>JSON parameters:</h4> |
| |
| <br/> |
| |
| </div> |
| <div style="float: left; width: 90%; "> |
| <h4>Response examples:</h4> |
| <blockquote><div style='float: left; width: 90%;'><pre style='width: 600px;'><b>200</b>: |
| { |
| "rows": [ |
| { |
| "children": [ |
| { |
| "blocks": 4, |
| "representation": "donut", |
| "name": "Widget Title", |
| "datatype": "repo", |
| "source": "code-evolution", |
| "type": "My Widget" |
| } |
| ] |
| } |
| ] |
| }</pre> |
| </div> |
| <div style='float: left; width: 90%;'><pre style='width: 600px;'><b>default</b>: |
| { |
| "code": 403, |
| "reason": "You need to be logged in to view this endpoint!" |
| }</pre> |
| </div> |
| </blockquote> |
| </div> |
| </div> |
| </div> |
| |
| </body></html> |