List

List

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

Get a list of reports for the given app.

Path Parameters

app_idstring

The appId field.

Query Parameters

page_sizenumber

optional

The pageSize field.

formatint32

page_tokenstring

optional

The pageToken field.

Returns

listarray of object

optional

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.

createdAtstring

optional

formatdate-time

downloadUrlstring

optional

The downloadUrl is the url used for downloading the AppPopulationReport.

hashesmap

optional

The hashes field contains the file hashes of the report.

stateenum

optional

"REPORT_STATE_UNSPECIFIED" OR "REPORT_STATE_PENDING" OR "REPORT_STATE_OK" OR "REPORT_STATE_ERROR"

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

"REPORT_STATE_UNSPECIFIED"

"REPORT_STATE_PENDING"

"REPORT_STATE_OK"

"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 cURL

curl https://{tenantDomain}.conductor.one/api/v1/apps/$APP_ID/report \
    -H "Authorization: Bearer $CONDUCTORONE_SDK_API_KEY"

200 Example

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