Skip to main content
POST
Export the company's milestone items as a CSV

Authorizations

Authorization
string
header
required

Bearer token authentication

Body

application/json

The range and filters of the milestone report. A page is not taken.

from
string<date>

The first day (UTC). Defaults to 29 days before to.

to
string<date>

The last day (UTC), inclusive. Defaults to today. At most 365 days after from.

rule_id
integer

Only the grants of this rule.

status
enum<string>

Only the grants in this status.

Available options:
planned,
on_order,
fulfilled,
deferred,
skipped_out_of_stock,
voided
source
enum<string>

Only the grants from this source.

Available options:
rule,
manual,
retention_offer

Response

Success

The link sits at the top level of the body, beside status and meta, with no wrapper key.

url
string<uri>
required

A signed link to the CSV. It expires 12 hours after the response.

status
enum<integer>
required
Available options:
200
meta
object
required