List visualizations for an AOI

GET

aois

{aoi_id}

visualizations

curl --request GET \
  --url https://api.pixxel.space/v0/aois/{aoi_id}/visualizations \
  --header 'Authorization: <api-key>'

{
  "pagination": {
    "total": 100,
    "offset": 0,
    "limit": 10
  },
  "visualization": [
    {
      "aoi_id": "e9767554-550e-4464-a677-b8cf096073ab",
      "assets": [
        {
          "aoi_id": "e9767554-550e-4464-a677-b8cf096073ab",
          "area_in_sq_m": 0,
          "asset_type": "mosaic",
          "band_list": [
            "B01",
            "B02"
          ],
          "centroid": [
            77.55,
            12.95
          ],
          "created_at": "2022-11-14 12:55:49.125928+00:00",
          "date": "2022-11-14",
          "description": "This asset is mosaic file",
          "geometry": {
            "coordinates": [
              [
                [
                  123
                ]
              ]
            ],
            "type": "<string>"
          },
          "id": "e9767554-550e-4464-a677-b8cf096073ab",
          "name": "Asset-A",
          "path": "https://storage.account",
          "progress": 0,
          "status": "success",
          "updated_at": "2022-11-14 12:55:49.125928+00:00",
          "visualization_id": "e9767554-550e-4464-a677-b8cf096073ab"
        }
      ],
      "created_at": "2022-11-14 12:55:49.125928+00:00",
      "expression": "(B08 - B04) / (B08 + B04)",
      "expression_type": "index",
      "id": "a80f7f4c-abe9-4118-875e-3a2306577e11",
      "index_id": "90d63531-5f54-4704-a4b0-7bb92ae08f23",
      "index_name": "NDVI-Custom",
      "progress": 100,
      "rescale": [
        0,
        1
      ],
      "status": "success",
      "tenant_id": "tenant-123456",
      "type": "custom",
      "updated_at": "2022-11-14 12:55:49.125928+00:00",
      "user_id": "e3a671ad-5381-4413-8c1c-bc4e1ccaff45"
    }
  ]
}

📚 View developer guide to learn more

Authorizations

Authorization

string

header

required

Path Parameters

aoi_id

string

required

AOI ID

Query Parameters

offset

integer

default:0

Offset for pagination

limit

integer

default:10

Limit for pagination

type

string

Filter by type

user_id

string

Filter by user ID

expression_type

string

Filter by expression type

index_id

string

Filter by index ID

visualization_id

string

Filter by visualization ID

Response

pagination

object

Show child attributes

pagination.total

integer

Example:

100

pagination.offset

integer

Example:

0

pagination.limit

integer

Example:

10

visualization

object[]

Show child attributes

visualization.aoi_id

string

Example:

"e9767554-550e-4464-a677-b8cf096073ab"

visualization.assets

object[]

Show child attributes

visualization.assets.aoi_id

string

Example:

"e9767554-550e-4464-a677-b8cf096073ab"

visualization.assets.area_in_sq_m

number

Example:

0

visualization.assets.asset_type

enum<string>

Available options:

mosaic,

stac_item,

visualization

Example:

"mosaic"

visualization.assets.band_list

string[]

Example:

["B01", "B02"]

visualization.assets.centroid

number[]

Example:

[77.55, 12.95]

visualization.assets.created_at

string

Example:

"2022-11-14 12:55:49.125928+00:00"

visualization.assets.date

string

Example:

"2022-11-14"

visualization.assets.description

string

Example:

"This asset is mosaic file"

visualization.assets.geometry

object

Show child attributes

visualization.assets.geometry.coordinates

number[][][]

visualization.assets.geometry.type

string

visualization.assets.id

string

Example:

"e9767554-550e-4464-a677-b8cf096073ab"

visualization.assets.name

string

Example:

"Asset-A"

visualization.assets.path

string

Example:

"https://storage.account"

visualization.assets.progress

integer

Example:

0

visualization.assets.status

enum<string>

Available options:

success,

failed,

started,

creating

Example:

"success"

visualization.assets.updated_at

string

Example:

"2022-11-14 12:55:49.125928+00:00"

visualization.assets.visualization_id

string

Example:

"e9767554-550e-4464-a677-b8cf096073ab"

visualization.created_at

string

Example:

"2022-11-14 12:55:49.125928+00:00"

visualization.expression

string

Example:

"(B08 - B04) / (B08 + B04)"

visualization.expression_type

enum<string>

Available options:

composite,

index,

grayscale

Example:

"index"

visualization.id

string

Example:

"a80f7f4c-abe9-4118-875e-3a2306577e11"

visualization.index_id

string

Example:

"90d63531-5f54-4704-a4b0-7bb92ae08f23"

visualization.index_name

string

Example:

"NDVI-Custom"

visualization.progress

integer

Example:

100

visualization.rescale

integer[]

Example:

[0, 1]

visualization.status

enum<string>

Available options:

creating,

success,

failed,

partial_success

Example:

"success"

visualization.tenant_id

string

Example:

"tenant-123456"

visualization.type

enum<string>

Available options:

custom

Example:

"custom"

visualization.updated_at

string

Example:

"2022-11-14 12:55:49.125928+00:00"

visualization.user_id

string

Example:

"e3a671ad-5381-4413-8c1c-bc4e1ccaff45"

Create a new visualizationCreates a new visualization for an AOI using the specified index and assets

⌘I

List visualizations for an AOI

curl --request GET \
  --url https://api.pixxel.space/v0/aois/{aoi_id}/visualizations \
  --header 'Authorization: <api-key>'

{
  "pagination": {
    "total": 100,
    "offset": 0,
    "limit": 10
  },
  "visualization": [
    {
      "aoi_id": "e9767554-550e-4464-a677-b8cf096073ab",
      "assets": [
        {
          "aoi_id": "e9767554-550e-4464-a677-b8cf096073ab",
          "area_in_sq_m": 0,
          "asset_type": "mosaic",
          "band_list": [
            "B01",
            "B02"
          ],
          "centroid": [
            77.55,
            12.95
          ],
          "created_at": "2022-11-14 12:55:49.125928+00:00",
          "date": "2022-11-14",
          "description": "This asset is mosaic file",
          "geometry": {
            "coordinates": [
              [
                [
                  123
                ]
              ]
            ],
            "type": "<string>"
          },
          "id": "e9767554-550e-4464-a677-b8cf096073ab",
          "name": "Asset-A",
          "path": "https://storage.account",
          "progress": 0,
          "status": "success",
          "updated_at": "2022-11-14 12:55:49.125928+00:00",
          "visualization_id": "e9767554-550e-4464-a677-b8cf096073ab"
        }
      ],
      "created_at": "2022-11-14 12:55:49.125928+00:00",
      "expression": "(B08 - B04) / (B08 + B04)",
      "expression_type": "index",
      "id": "a80f7f4c-abe9-4118-875e-3a2306577e11",
      "index_id": "90d63531-5f54-4704-a4b0-7bb92ae08f23",
      "index_name": "NDVI-Custom",
      "progress": 100,
      "rescale": [
        0,
        1
      ],
      "status": "success",
      "tenant_id": "tenant-123456",
      "type": "custom",
      "updated_at": "2022-11-14 12:55:49.125928+00:00",
      "user_id": "e3a671ad-5381-4413-8c1c-bc4e1ccaff45"
    }
  ]
}

external

Project

AOI

Search

Indices

Visualizations

Blocks

Insights

Assets

Downloads

Workflows

Jobs

Tasks

Bandset

Order

Archives

Report

Stores

Catalog

List visualizations for an AOI

Authorizations

Path Parameters

Query Parameters

Response