MOmountain
mss-api-controller

MSS Get Data Query

After validating the user request api key runs a query against the reporting data service

get/select/apidata

Request

Query parameters

keystring

API Key

allownullboolean

column to group by

dataColumnNames[] required
sumColumnNames[]
filterstring

Optional filter as a URL-encoded JSON object using the same filter types as the POST body filter field.

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).

beginstring required

start date of the query

endstring

end date of the query

oidinteger[] required

list of advertiser ids to query

format'human' | 'json' | 'csv' | 'excel'

defines the content type of the response

formatdataboolean

when set to true, the values in the response data will be each be formatted

fullnameboolean
includetodayboolean

when set to true, the response will include the current day's data

period'day' | 'week' | 'month' | 'year'

when set, the response will group the data by the input period

limitinteger

when set, the number of rows returned will be limited to this number

offsetinteger

when set, the query will skip this number of rows. Used for pagination

sortstring[]

when set, data will be returned sorted by this column and direction

accounttypesinteger[]

List of account type IDs

dataColumnsstring[] 
{
  "data": [
    "impressions",
    "visits",
    "conversions"
  ],
  "aid": [
    22920
  ],
  "begin": "2022-10-01",
  "end": "2022-11-01",
  "sum": [
    "campaigngroupid"
  ]
}

Response

OK

object required

Changes

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