MOmountain
Batch

Submit an async export job

Queues a CSV export for the authenticated advertiser. Returns 202 Accepted with a batchId and initial status; poll GET /batch/{batchId} until SUCCEEDED, then use the signed downloadUrl.

post/batch

Request

Request body

keystring required

API Key

beginstring required

Start date (YYYY-MM-DD) or keyword

endstring

End date (YYYY-MM-DD); required when begin is an explicit date and ignored for keyword begin

format'csv'

Output format

fullnameboolean

Include table prefix in column names

includetodayboolean

Include current day's partial data

limitinteger

Max rows returned; defaults to the configured export maximum when omitted

offsetinteger

Row offset for pagination

sortstring[]

Sort order (column direction)

sumstring[]

Group-by columns

reportNamestring

Optional report name for identification

filterFilter

Optional JSON object that restricts which rows are returned. Use the same shape for POST filter and GET filter (URL-encoded).

Filter types — column predicates: Each property key is a column identifier (table.column). The value can be:

  • Operator object: keys are operator names and values are comparison values (for example {"equals": "Live"}, {"in": ["a","b"]}).
  • Scalar (string or number): shorthand for equals.
  • Array: shorthand for membership (in).

Filter types — logical groups: Properties named AND, OR, or NOT hold a nested object that follows the same rules (more column predicates and/or nested AND / OR / NOT).

Operator keys (allowed keys inside an operator object): equals, not, in, notIn, lt, lte, gt, gte, contains, notContains, startsWith, endsWith, hasAny.

Use GET /apilist to discover valid column identifiers (for data, sum, and filter).

allownullboolean
formatdataboolean
nodatatiercheckstring
periodstring
dataColumnsstring[]

Response

Job accepted

batchIdinteger
statusstring
submittedAtstring
reportNamestring

Changes

No recorded changes to this operation across all 1 revision of this API.