List

List

client.Apps.Report.List(ctx, appID, query) (*ListarrayNextPageTokenstringAppReportListResponse, error)

get/api/v1/apps/{app_id}/report

Get a list of reports for the given app.

Parameters

appIDstring

The appId field.

queryPageSizefieldPageTokenfieldAppReportListParams

Hide ParametersShow Parameters

PageSizefield

optional

param.Field[int64]

The pageSize field.

formatint32

PageTokenfield

optional

param.Field[string]

The pageToken field.

Returns

AppReportListResponsestruct

The AppReportServiceListResponse message contains a list of results and a nextPageToken if applicable.

Hide ParametersShow Parameters

Listarray

optional

[]AppReportListResponseList

The list of results containing up to X results, where X is the page size defined in the request.

Hide ParametersShow Parameters

IDstring

optional

The id field.

AppIDstring

optional

The appId is the Id of the app which the report is generated for.

CreatedAtTime

optional

formatdate-time

DownloadURLstring

optional

The downloadUrl is the url used for downloading the AppPopulationReport.

Hashesmap

optional

map[string, string]

The hashes field contains the file hashes of the report.

Statestring

optional

The state field tracks the state of the AppPopulationReport. This state field can be one of REPORT_STATE_PENDING, REPORT_STATE_UNSPECIFIED, REPORT_STATE_OK, REPORT_STATE_ERROR.

Hide ParametersShow Parameters

AppReportListResponseListStateReportStateUnspecifiedconst

AppReportListResponseListStateReportStateUnspecifiedAppReportListResponseListStateAppReportListResponseListStateReportStatePendingAppReportListResponseListStateAppReportListResponseListStateReportStateOkAppReportListResponseListStateAppReportListResponseListStateReportStateErrorAppReportListResponseListStateAppReportListResponseListState

"REPORT_STATE_UNSPECIFIED"

AppReportListResponseListStateReportStatePendingconst

AppReportListResponseListStateReportStateUnspecifiedAppReportListResponseListStateAppReportListResponseListStateReportStatePendingAppReportListResponseListStateAppReportListResponseListStateReportStateOkAppReportListResponseListStateAppReportListResponseListStateReportStateErrorAppReportListResponseListStateAppReportListResponseListState

"REPORT_STATE_PENDING"

AppReportListResponseListStateReportStateOkconst

AppReportListResponseListStateReportStateUnspecifiedAppReportListResponseListStateAppReportListResponseListStateReportStatePendingAppReportListResponseListStateAppReportListResponseListStateReportStateOkAppReportListResponseListStateAppReportListResponseListStateReportStateErrorAppReportListResponseListStateAppReportListResponseListState

"REPORT_STATE_OK"

AppReportListResponseListStateReportStateErrorconst

AppReportListResponseListStateReportStateUnspecifiedAppReportListResponseListStateAppReportListResponseListStateReportStatePendingAppReportListResponseListStateAppReportListResponseListStateReportStateOkAppReportListResponseListStateAppReportListResponseListStateReportStateErrorAppReportListResponseListStateAppReportListResponseListState

"REPORT_STATE_ERROR"

NextPageTokenstring

optional

The nextPageToken is shown for the next page if the number of results is larger than the max page size. The server returns one page of results and the nextPageToken until all results are retreived. To retrieve the next page, use the same request and append a pageToken field with the value of nextPageToken shown on the previous page.

Request example Go

package main

import (
  "context"
  "fmt"

  "github.com/stainless-sdks/-go"
  "github.com/stainless-sdks/-go/option"
)

func main() {
  client := conductoronesdk.NewClient(
    option.WithAPIKey("My API Key"),
  )
  reports, err := client.Apps.Report.List(
    context.TODO(),
    "app_id",
    conductoronesdk.AppReportListParams{

    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", reports.List)
}

200 Example

{
  "list": [
    {
      "id": "id",
      "appId": "appId",
      "downloadUrl": "downloadUrl",
      "hashes": {
        "foo": "string"
      },
      "state": "REPORT_STATE_UNSPECIFIED"
    }
  ],
  "nextPageToken": "nextPageToken"
}