Reports API Reference

• Download Reports
  • getList Download Reports
  • getGet a Download Report
  • getGet a Download Report's content
• PV Reports
  • getList PV Reports
  • getGet a PV Report
• Downloads Reports (Sub Orgs)
  • postCreate a SubOrg Download Report
  • getSubOrg Download Report
  • getSubOrg Download Report's Content
• Tiles Streaming Reports
  • getGet Tiles Usage Report
• Tasking Reports
  • getGet Tasking Usage Report
• Footprints Reports
  • getGet Footprints Usage Reports
  • getGet a single Footprints Usage Report

API docs by Redocly

Reports API (1.0.0)

Download OpenAPI specification:Download

Access & Create Usage Reports

Download Reports

List Download Reports

List reports, using and filtering logic based on parameters

query Parameters

org_id	integer ID of org to query, defaults to token claims
plan_id	integer Include reports generated for the given Plan ID
report_type	string (ReportType) Enum: "detailed" "summary" Report type
cadence	string Enum: "daily" "monthly" Report cadence
start	string <date> Include reports on or after this date
end	string <date> Include reports on or before this date
page_size	integer Number of records to return per page, defaults to 50.
after	string Paging navigation - specifies ID of report to start listing from.
offset	integer (Offset) >= 0 Number of results to skip in a query

Responses

API Server

https://api.planet.com/reports/v1/

Response samples

• 200

Content type

application/json

{

• "reports": [

  • {

    • "report_id": "string",
    • "contents": [

      • "string"

      ],
    • "org_id": 0,
    • "plan_id": 0,
    • "data_date_start": "2019-08-24",
    • "data_date_end": "2019-08-24",
    • "report_type": "detailed",
    • "num_rows": 0,
    • "cadence": "daily",
    • "has_footprint": true,
    • "_links": {

      • "self": "string"

      }

    }

  ],
• "_links": {

  • "next": "string"

  }

}

Get a Download Report

Get a report by ID

path Parameters

id required

string ID of report to get

Responses

API Server

https://api.planet.com/reports/v1/{id}

Get a Download Report's content

Download a report

path Parameters

id required	string ID of report to get
part required	integer Part of report to get

Responses

API Server

https://api.planet.com/reports/v1/{id}/content/{part}

PV Reports

List PV Reports

List PV reports, using filtering logic based on parameters

query Parameters

org_id	integer ID of org to query, defaults to token claims
plan_id	integer Include PV reports generated for the given Contract ID
line_item_id	integer Include PV reports generated for the given Line Item ID
report_type	string (PvReportType) Enum: "pv_detailed" "billableaoi_detailed" PV report type
cadence	string (Cadence) Enum: "daily" "monthly" PV report cadence Please note that no monthly reports are created for the pv_detailed report_type. A list of monthly pv_detailed reports will always be empty
start	string <date> Include PV reports on or after this date
end	string <date> Include PV reports on or before this date
page_size	integer Number of records to return per page, defaults to 50 for PV reports.
after	string Paging navigation - specifies ID of PV report to start listing from.
offset	integer (Offset) >= 0 Number of results to skip in a query

Responses

API Server

https://api.planet.com/reports/v1/pv/

Response samples

• 200

Content type

application/json

{

• "reports": [

  • {

    • "report_id": "string",
    • "contents": [

      • "string"

      ],
    • "org_id": 0,
    • "plan_id": 0,
    • "data_date_start": "2019-08-24",
    • "data_date_end": "2019-08-24",
    • "report_type": "detailed",
    • "num_rows": 0,
    • "cadence": "daily",
    • "has_footprint": true,
    • "_links": {

      • "self": "string"

      }

    }

  ],
• "_links": {

  • "next": "string"

  }

}

Get a PV Report

Get a PV report by ID

path Parameters

reportId required

string ID of the PV report to get

Responses

API Server

https://api.planet.com/reports/v1/pv/{reportId}

Downloads Reports (Sub Orgs)

Create a SubOrg Download Report

Request to generate a download usage report of "all" or "selected" Suborganizations of the Organization the requesting user belongs to.

Request Body schema: application/json

required

report_type	string (ReportType) Enum: "detailed" "summary"
cadence	string (Cadence) Enum: "daily" "monthly"
	object (TOI) Time of interest, the time window cannot be greater than 90 days, start date and end date included
	object

Responses

API Server

https://api.planet.com/reports/v1/downloads/suborgs

Request samples

• Payload

Content type

application/json

{

• "report_type": "detailed",
• "cadence": "daily",
• "toi": {

  • "start_date": "2019-08-24",
  • "end_date": "2019-08-24"

  },
• "suborgs": {

  • "include": "all",
  • "ids": [

    • 0

    ]

  }

}

SubOrg Download Report

Get a sub org report by ID

path Parameters

id required

string <uuid> ID of sub org report

Responses

API Server

https://api.planet.com/reports/v1/downloads/suborgs/{id}

SubOrg Download Report's Content

Download a report

path Parameters

id required	string <uuid> ID of suborg report to get
part required	integer Part of report to get

Responses

API Server

https://api.planet.com/reports/v1/downloads/suborgs/{id}/content/{part}

Tiles Streaming Reports

Get Tiles Usage Report

Download tiles usage report

path Parameters

planID required

integer ID of plan to request the report (you can find this ID in the Accounts Page)

query Parameters

start required	string <date> The report will include results after this date (YYYY-MM-DD)
end required	string <date> The report will include results before this date (YYYY-MM-DD)
include_user required	boolean If true, the report will contains the user
interval required	string (Cadence) Enum: "daily" "monthly" Report cadence, can be daily or monthly
type	string (Type) Enum: "scenes" "basemaps" Optional filter by tile type, can be scenes or basemaps
include_subject	boolean If true, the report will include the subject for every streaming event

Responses

API Server

https://api.planet.com/reports/v1/plans/{planID}/tiles/usage

Response samples

• 400
• 401

Content type

application/json

{

• "field": {

  • "property1": [

    • {

      • "message": "string"

      }

    ],
  • "property2": [

    • {

      • "message": "string"

      }

    ]

  },
• "general": [

  • {

    • "message": "string"

    }

  ]

}

Tasking Reports

Get Tasking Usage Report

Download a usage report for a tasking contract

path Parameters

contractId required

string tasking contract ID (pl-number)

query Parameters

limit	integer Max. number of rows to return
exclude	string Column headers to be excluded from the CSV report. Include the query param for each column

Responses

API Server

https://api.planet.com/reports/v1/tasking/{contractId}/usage

Footprints Reports

Get Footprints Usage Reports

Returns the download footprints geometry reports generated for the given Plan ID

path Parameters

planId required

integer ID of the plan

Responses

API Server

https://api.planet.com/reports/v1/footprints/{planId}

Response samples

• 200

Content type

application/json

{

• "reports": [

  • {

    • "id": "string",
    • "report_date": "2019-08-24",
    • "report_type": "detailed",
    • "usage_bucket": "string",
    • "org": 0,
    • "package": 0,
    • "plan": 0,
    • "content_link": "string"

    }

  ]

}

Get a single Footprints Usage Report

Returns the download footprints report generated for the given Plan ID and Report Id

path Parameters

planId required	integer ID of the plan
reportId required	string <uuid> ID of the requested report

Responses

API Server

https://api.planet.com/reports/v1/footprints/{planId}/{reportId}

Response samples

• 200

Content type

application/json

Example

PolygonMultiPolygonPolygon

{

• "type": "Polygon",
• "coordinates": [

  • [

    • [

      • 0,
      • 0

      ]

    ]

  ]

}