Advertising API

Section: Account

This section performs operations for your account

Available Resource List

Action Type Resource Description
Available Destination Organizations http://api.dmds.com/api/v1/ad/account/availableDestinations Resource to get available destination organizations for this account
Destination Organization Status http://api.dmds.com/api/v1/ad/account/destinationOrganizationStatus/{organizationID} Resource to get the status for a specified organization destination
Logs http://api.dmds.com/api/v1/ad/account/logs Resource to get a historical record of previous API calls


Available Destination Organizations

Http Operations Supported

  • GET

HTTP GET Resource URI

  • GET http://api.dmds.com/api/v1/ad/account/availableDestinations
  • QUERYSTRING: ?status={statusVal}

Supported Http Request Accept Types

  • application/xml
  • text/xml
  • application/json

Additional QUERYSTRING Filters (Optional)

Parameter Parameter Type Description Default Value Examples
status One of:
  • all
  • online
  • offline
 A filter on organization status all all, online
updatedSince datetime Filter destinations to only return those updated since the specified date-time. Specified date-time should be in Eastern Time no filter 2014-10-01T12:00:00, 2014-12-31T23:59:59

Supported Response Types

  • application/xml
  • text/xml
  • application/json

Output Schema

Destination Organization Status

Http Operations Supported

  • GET

HTTP GET Resource URI

  • GET http://api.dmds.com/api/v1/ad/account/destinationOrganizationStatus/{organizationID}

Supported Http Request Accept Types

  • application/xml
  • text/xml
  • application/json

Resource Parameters

Parameter Parameter Type Description Examples
organizationID The organizationID to get the status for 11, 123

Output Schema



Logs

Http Operations Supported

  • GET

HTTP GET Resource URI

  • GET http://api.dmds.com/api/v1/music/account/logs
  • QUERYSTRING: ?dateFrom={dateFromVal}&dateTo={dateToVal}&url={urlVal}&httpMethod={httpMethodVal}

Supported Http Request Accept Types

  • application/xml
  • text/xml
  • application/json

Additional QUERYSTRING Filters (Optional)

Parameter Parameter Type Description Examples
dateFrom Date (YYYY-MM-DD) Retrieve logs with a request date beginning on this date 2013-05-10
dateTo Date (YYYY-MM-DD) Retrieve logs with a request date ending on this date 2013-05-10
url string Retrieve only logs matching this request URL. This can be specific:
http://api.dmds.com/api/v1/ad/orders/1234567
or generic:
http://api.dmds.com/api/v1/ad/orders/{orderID}
httpMethod One of:
  • GET
  • POST
  • PUT
  • DELETE
 Retrieve only logs matching this http method. GET, POST

Supported Response Types

  • application/xml
  • text/xml
  • application/json

Output Schema

API Reference