ATathenian
filter
default

Find various JIRA entities relevant to the specified date interval.

Changed on
post/filter/jira

Request

Request body

accountinteger required

Session account ID.

date_fromstring date nullable required

null disables the time filter boundary, thus everything is returned. date_from and date_to must be both either null or not null.

date_tostring date nullable required

null disables the time filter boundary, thus everything is returned. date_from and date_to must be both either null or not null.

timezoneinteger

Local time zone offset in minutes, used to adjust date_from and date_to.

prioritiesstring[]

Selected issue priorities.

typesstring[]

Selected issue types. Ignored for epics.

labels_includestring[]

JIRA issues must contain at least one label from the list. Several labels may be concatenated by a comma , so that all of them are required.

labels_excludestring[]

JIRA issues may not contain labels from this list.

exclude_inactiveboolean required

Value indicating whether issues with the last update older than date_from should be ignored. If date_from and date_to are null, does nothing.

projectsstring[]

Issues must belong to these JIRA projects.

returnJIRAFilterReturn[]

Specifies which items are required, an empty or missing array means everything.

Example request

{
  "account": 1,
  "date_from": "2020-01-01",
  "date_to": "2020-12-01",
  "timezone": 120,
  "exclude_inactive": true
}

Response

List of found JIRA entities, ordered by the last usage time.

Example response

{
  "epics": [
    {
      "id": "DEV-158",
      "title": "Precomputed DB - stage 2",
      "created": "2020-05-21T18:27:00Z",
      "updated": "2020-08-03T23:47:00Z",
      "reporter": "Vadim Markovtsev",
      "assignee": "Vadim Markovtsev",
      "comments": 1,
      "prs": 0,
      "priority": "Low",
      "status": "Backlog",
      "type": "Epic",
      "acknowledge_time": "132200s",
      "life_time": "59172893s",
      "url": "https://example.com/?my-jira#DEV-158",
      "project": "10012",
      "story_points": 5,
      "children": [
        {
          "id": "DEV-157",
          "title": "New repository for the precomputing service",
          "created": "2020-05-21T18:29:00Z",
          "updated": "2020-11-25T13:49:00Z",
          "reporter": "Vadim Markovtsev",
          "assignee": "Oleksandr Chabaiev",
          "comments": 10,
          "priority": "Low",
          "status": "Released",
          "prs": 0,
          "type": "Task",
          "url": "https://example.com/?my-jira#DEV-157",
          "acknowledge_time": "132200s",
          "life_time": "59172892s",
          "subtasks": 42
        },
        {
          "id": "DEV-156",
          "title": "Design the architecture of the precomputing service",
          "created": "2020-05-21T18:27:00Z",
          "updated": "2020-09-09T00:05:00Z",
          "reporter": "Vadim Markovtsev",
          "assignee": "Vadim Markovtsev",
          "comments": 0,
          "priority": "Low",
          "status": "Released",
          "prs": 0,
          "type": "Task",
          "url": "https://example.com/?my-jira#DEV-156",
          "acknowledge_time": "132200s",
          "life_time": "59172891s",
          "subtasks": 3,
          "story_points": 5
        }
      ]
    }
  ],
  "issues": [],
  "labels": [
    {
      "title": "performance",
      "last_used": "2020-08-10T12:47:00Z",
      "issues_count": 300,
      "kind": "regular"
    },
    {
      "title": "performance",
      "last_used": "2020-08-10T12:47:00Z",
      "issues_count": 300,
      "kind": "regular"
    }
  ],
  "issue_types": [
    {
      "name": "Bug",
      "normalized_name": "bug",
      "count": 12,
      "image": "https://athenianco.atlassian.net/secure/viewavatar?size=medium&avatarId=10303&avatarType=issuetype",
      "project": "10009",
      "is_subtask": false,
      "is_epic": false
    },
    {
      "name": "Task",
      "normalized_name": "task",
      "count": 6,
      "image": "https://athenianco.atlassian.net/secure/viewavatar?size=medium&avatarId=10318&avatarType=issuetype",
      "project": "10009",
      "is_subtask": false,
      "is_epic": false
    }
  ],
  "priorities": [
    {
      "name": "None",
      "image": "https://athenianco.atlassian.net/images/icons/priorities/trivial.svg",
      "rank": 3,
      "color": "FFAA00"
    },
    {
      "name": "High",
      "image": "https://athenianco.atlassian.net/images/icons/priorities/high.svg",
      "rank": 5,
      "color": "001123"
    }
  ],
  "statuses": [
    {
      "name": "Released",
      "stage": "Done",
      "project": "10009"
    }
  ],
  "users": [
    {
      "name": "Vadim Markovtsev",
      "avatar": "https://avatar-management-avatars.us-west-2.prod.public.atl-paas.net/5de504edde32fb0d03a3b4e3/8c3ffc1b-2ac0-488e-ac55-295ff06f9e28/48",
      "type": "atlassian"
    },
    {
      "name": "Lou Marvin Caraig",
      "avatar": "https://avatar-management-avatars.us-west-2.prod.public.atl-paas.net/5ddec0b9be6c1f0d071ff82d/24b3b66a-a251-486c-ae1f-5daa954eba54/48",
      "type": "atlassian"
    }
  ]
}

Changes

  • 4dcbf99639b4Revision changes
    • info

      added the required property ////// to the response with the status

    • info

      added the required property ///////// to the response with the status

    • info

      added the required property ////// to the response with the status

  • 0cc28e1bffc4Revision changes
    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ////// to the response with the status