Skip to content
View as Markdown

ListIssuesRequest

Source definition: src/bitdrift/public/unary/issues/v1/issues.proto#L342-L408

Field Type Description
issue_group_id string
between 1 and 100 chars
The unique identifier for the issue group this issue belongs to.
offset uint32 Used to paginate through results. To get the next page result, set this to the desired starting offset. For example, setting to 10 will start with the 10th record. The default value is 0.
limit optional uint32
between 1 and 100
This defines the upper bound of the number of items returned. The maximum value supported is 100, meaning that we’ll never return more than max(items.count, limit, 100).
filters array of bitdrift.public.unary.issues.v1.ListIssuesRequest.ListIssuesFilters
up to 100 items
Filter the list of issues based on the current user's relationship to the issue. This is a logical AND. If no filters are supplied, all issues are returned.
issue_query bitdrift.public.unary.issues.v1.IssueQuery
sort array of bitdrift.public.unary.issues.v1.ListIssuesRequest.Sort
up to 100 items
Orders issues by caller-visible attributes. Apply criteria in the order provided.

Example

JSON
{
  "filters": [
    {
      "platform": {
        "value": [
          {
            "apple": {
              "apps": [
                {
                  "app_id": "com.example.app"
                }
              ]
            }
          }
        ]
      }
    }
  ],
  "issue_group_id": "12710232306638153143",
  "issue_query": {
    "advanced_filters": {
      "and_conditions": [
        {
          "or_conditions": [
            {
              "lhs_typed": "LHS_TYPED_APP_ID",
              "operator": "EQUAL",
              "rhs": "com.example.app"
            }
          ]
        }
      ]
    },
    "feature_flag_filters": [
      {
        "exclusive": false,
        "name": "EXC_BAD_ACCESS",
        "variant": "null pointer"
      }
    ],
    "grouping_key": [
      "12710232306638153143"
    ],
    "platforms": [
      {
        "apple": {
          "apps": [
            {
              "app_id": "com.example.app"
            }
          ]
        }
      }
    ],
    "time_range": {
      "relative_time_range": {
        "duration": "3600s",
        "offset": "3600s"
      }
    }
  },
  "limit": 25,
  "offset": 1,
  "sort": [
    {
      "direction": "DESCENDING",
      "key": "OCCURRED_AT"
    }
  ]
}

ListIssuesRequest.Sort

Source definition: src/bitdrift/public/unary/issues/v1/issues.proto#L343-L355

Field Type Description
key bitdrift.public.unary.issues.v1.ListIssuesRequest.Sort.SortKey
must be a defined enum value
Selects which caller-visible issue attribute to order by.
direction bitdrift.public.unary.common.v1.SortDirection
must be a defined enum value
Selects whether results are returned in ascending or descending order.

Example

JSON
{
  "direction": "DESCENDING",
  "key": "OCCURRED_AT"
}

ListIssuesRequest.Sort.SortKey Enum

Source definition: src/bitdrift/public/unary/issues/v1/issues.proto#L344-L348

Name Number Description
SORT_KEY_UNSPECIFIED 0
OCCURRED_AT 1
ISSUE_REASON 2

ListIssuesRequest.ListIssuesFilters

Source definition: src/bitdrift/public/unary/issues/v1/issues.proto#L357-L378

Field Type Description
platform bitdrift.public.unary.issues.v1.ListIssuesRequest.ListIssuesFilters.Platform(Only one of platform, or time_range, advanced_filters can be set) Filters on the platform of issues.
time_range bitdrift.public.unary.issues.v1.ListIssuesRequest.ListIssuesFilters.TimeRange(Only one of time_range, or platform, advanced_filters can be set) Filters on the time range of issues.
advanced_filters bitdrift.public.unary.issues.v1.AdvancedFilter(Only one of advanced_filters, or platform, time_range can be set) Filters on the advanced filters of issues.

Example

JSON
{
  "platform": {
    "value": [
      {
        "apple": {
          "apps": [
            {
              "app_id": "com.example.app"
            }
          ]
        }
      }
    ]
  }
}

ListIssuesRequest.ListIssuesFilters.Platform

Source definition: src/bitdrift/public/unary/issues/v1/issues.proto#L358-L361

Field Type Description
value array of bitdrift.public.shared.platform.v1.Platform
up to 100 items
The platform of an issue group to filter by.

Example

JSON
{
  "value": [
    {
      "apple": {
        "apps": [
          {
            "app_id": "com.example.app"
          }
        ]
      }
    }
  ]
}

ListIssuesRequest.ListIssuesFilters.TimeRange

Source definition: src/bitdrift/public/unary/issues/v1/issues.proto#L363-L365

Field Type Description
time_range bitdrift.public.unary.common.v1.TimeRange

Example

JSON
{
  "time_range": {
    "relative_time_range": {
      "duration": "3600s",
      "offset": "3600s"
    }
  }
}