Create Dashboard Widget

URL: /rest-api/dashboard/widget/create.do

Method: POST

Response format: application/json

Error codes:

  • 401 Unauthorized – authentication error.

Response sample:
200 OK

Parameters:

  • hash – an MD5 digest of a concatenated username's MD5 password and a given timestamp.
  • timestamp – UNIX timestamp in milliseconds used for hash generation.
  • username – a given username.
  • title – Widget title; required.
  • type – Widget type; required (available values: TABLE, LINE_CHART, PIE_CHART, BAR_CHART, NOTICE).
  • value – text content for Note widget.
  • x – X-coordinates for Widget location; optional (available values: 0-3).
  • y – Y-coordinates for Widget location; optional (available values: 0-127).
  • data.statisticType – type of analytics for analytical widgets (available values: BROWSER_OS, THIRD_PARTY_FILL_RATE, TARGETING_COOKIE, DSP_FILL_RATE, CLICKS_LOG, CONVERSIONS_LOG. Empty field stands for General analytics.
  • data.choosenMetric – metrics for analytics (available values: impressions, publisher_impressions, advertiser_impressions, clicks, publisher_clicks); required.
  • data.range – analytics timeframe metrics (available values: TODAY, YESTERDAY, CURRENT_WEEK, CURRENT_MONTH, LAST_7_DAYS, LAST_30_DAYS, LAST_MONTH, LAST_3_MONTH, LAST_6_MONTH, CURRENT_YEAR, LAST_YEAR, CUSTOM); Default value is TODAY.
  • data.customFrom – start date for time range (required if data.range=CUSTOM). Value should be in "DD/MM/YYYY" format, for example: "31/05/2016".
  • data.customTo – end date (required if data.range=CUSTOM). Value should be in "DD/MM/YYYY" format, for example: "31/05/2016".
  • data.groupRange – grouping by time (available values: NONE, HOUR, DAY, MONTH, YEAR; required.
  • data.groupBy – grouping by entity (available values: SITE, ZONE, PLACEMENT, PLACEMENT_SIZE, PLACEMENT_LABEL, ADVERTISER, CAMPAIGN, BANNER, BANNER_LABEL, BANNER_TEMPLATE, CHANNEL, COUNTRY, ACTION; required.
  • data.eqLong['ADVERTISER|SITE|CAMPAIGN...'] – filter by entity IDs. For example: "data.eqLong['ADVERTISER']=12,564,45222".
  • data.eqStr['COUNTRY|BROWSER|OPERATING_SYSTEM...'] – filter by parameters. For example: "data.eqStr['BROWSER']=11 or data.eqStr['COUNTRY']=US".

Delete Dashboard Widget

URL: /rest-api/dashboard/widget/delete.do

Method: POST

Response format: application/json

Error codes:

  • 401 Unauthorized – authentication error.

Response sample:
200 OK

Parameters:

  • hash – an MD5 digest of a concatenated username's MD5 password and a given timestamp.
  • timestamp – UNIX timestamp in milliseconds used for hash generation.
  • username – a given username.
  • id – Widget ID.

Need more help?

Should you require any additional help with our solutions, do not hesitate to contact Epom technical support at support@epom.com. Our support managers are dedicated to resolving any issues and providing you with solutions and support if you face difficulties or have questions.