Reporting API v0 Release Notes

The Reporting API allows to retrieve the reports about the performance of accounts and campaigns.

Contact: api@acquisio.com

Releases by year:


30 September 2019

Improved endpoints

Most endpoints

  • A new Display Ad Platform named The Trade Desk is now supported. The Trade Desk statistics can be retrieved for accounts, Ad Platform Accounts, campaigns, ad groups and ads. Statistics specific to The Trade Desk can be requested with the new statistics query parameter.

16 September 2019

Improved endpoints

Most endpoints

  • A new Display Ad Platform named Programmatic1 is now supported. Programmatic1 statistics can be retrieved for accounts, Ad Platform Accounts, campaigns, ad groups and ads. Statistics specific to Programmatic1 can be requested with the new statistics query parameter.

10 September 2019

Improved endpoints

Most endpoints

  • DeviceType segment is now supported for Microsoft Advertising. The feature was previously limited to Google Ads. Refer to the Segments documentation for more details.

31 July 2019

Ads

  • GET
    /ads
    : It’s now possible to retrieve the images of Facebook ads with a better resolution by adding embed=images to the query parameters.

25 July 2019

Breaking changes

Most endpoints

  • The statistics.conversions statistic is now a Decimal instead of an Integer to support the fractional conversions of Google Ads.

27 June 2019

New endpoints

Markups

  • GET
    /markups
    : Retrieve the markup rates that are applied on cost statistics.

28 May 2019

Improved endpoints

Campaigns

  • Campaign labels are now supported. See the query parameter embed on the campaigns endpoint for more details.

New endpoints


21 May 2019

Documentation changes

  • References to Bing Ads has been replaced by Microsoft Advertising, due to the recent rebranding.

Breaking changes

Most endpoints

  • The constant BingAds has been renamed to MicrosoftAdvertising. The rename affects the response field type of Ad Platform Accounts and the response field adPlatformAccountType of Campaigns, Ad Groups, Keywords and Ads.

07 May 2019

Improved endpoints

Most endpoints

  • The query parameter statistics now allow to specify the statistics that should be returned in the response. This allows to reduce the latency of the API calls, especially when segments are used. For example, segments=Day&statistics=statistics.clicks,statistics.impressions is likely to be faster than segments=Day, since that second call include nine statistics by default.

01 May 2019

Improved endpoints

Most endpoints

  • A new Display Ad Platform named Simpli.fi is now supported. Simpli.fi statistics can be retrieved for accounts, Ad Platform Accounts, campaigns, ad groups and ads. Statistics specific to Simpli.fi can be requested with the new statistics query parameter.
  • It’s now possible to sort on a formula (ex: sort=formulas.CostPerImpression). Refer to the Formulas documentation for more details about how formulas works.
  • Formulas can now include the Conversion Count and Conversion Value statistics to calculate totals (ex: formulas=totalConversions:externalStatistics.convCount4 + externalStatistics.convCount12:Integer). Refer to the list of available statistics for more details.

23 April 2019

Improved endpoints

Most endpoints

  • Two new segments have been added to retrieve weekly statistics and monthly statistics. These new segments can be requested with segments=Week or segments=Month. See the Segments documentation for more details.

New endpoints

Ads


15 April 2019

New endpoints

Ad Platform Accounts


11 April 2019

New endpoints

Campaigns


25 February 2019

Improved endpoints

Ads

  • GET
    /ads
    : It’s now possible to retrieve the fields that are specific to a given type of ad (ex: Facebook Text Ad). Specific fields can be requested with &embed=specificFields. This new feature is currently limited to Facebook Ads. Filtering and sorting on specific fields isn’t yet supported.

Deprecations

Ads

  • GET
    /ads
    : The response field ads.name is deprecated and will be removed in the future. Specific fields should be used instead to retrieve information about an ad (with &embed=specificFields).

07 January 2019

Improved endpoints

Accounts

  • GET
    /accounts
    : Account custom fields can now be retrieved with &embed=customFields. Filters on custom fields are also supported (ex: &filter=customFields.field1:"Boston".
  • GET
    /accounts
    : Sorting on account labels is now available (ex: &sort=labels.Color:"Blue").

13 December 2018

Improved endpoints

Most endpoints

  • A generic Ad Platform named Virtual Search is now supported. Virtual Search allows to import in Acquisio the structure and statistics from additional Ad Platforms like Marchex and DialogTech.

End of preview

Most endpoints

  • Formulas (the query parameter formulas) and advanced filters (the query parameter filter) are now out of preview and are considered stable.

Deprecations

Most endpoints

  • Many superfluous query parameters that allow to filter on resources have been deprecated. The advanced filters (the filter query parameter) should be used instead. The deprecated query parameters will be removed in the future when the clients of Reporting API will no longer use them.

02 October 2018

Improved endpoints

Most endpoints

  • Formulas have been added to most endpoints (they were previously only available for campaigns). See the query parameter formulas on endpoints like accounts.

Accounts

  • Account labels can now be included in the response. See the query parameter embed on the accounts endpoint.

24 September 2018

Improved endpoints

Most endpoints

  • Most of the endpoints have a new response header X-TotalCount that indicates how many resources are available for that request in all pages.

Accounts


10 September 2018

New endpoints

Call details


09 July 2018

Improved endpoints

All endpoints

  • Segment filters on Device Type and Network type can be used to retrieve the statistics for specific devices or networks. Segment filters are part of the Advanced filters.

Campaigns


03 July 2018

Documentation changes

  • References to AdWords has been replaced by Google Ads, due to the recent rebranding.

Breaking changes

Most endpoints

  • The constant AdWords has been renamed to GoogleAds. The rename affects the response field type of Ad Platform Accounts and the response field adPlatformAccountType of Ad Groups, Keywords and Ads.

Improved endpoints

All endpoints

  • The new segments query parameter allows to define segment breakdowns to split the statistics by Day (daily statistics) and/or by Device Type.

27 June 2018

Improved endpoints

All endpoints

  • The new filter query parameter allows to define advanced filters to determine which resources should be returned. The feature is currently in preview (not considered stable yet).

Campaigns

  • GET
    /campaigns
    : The formulas query parameter now allows to set a type to change the format of the result.

23 May 2018

Improved endpoints

All endpoints

  • The new sort query parameter allows to define the order in which resources are returned.
  • The new name query parameter allows to retrieve Accounts, Ad Platform Accounts, Campaigns, Ad Groups and Ads by their name.
  • The new text query parameter allows to retrieve Keywords by their text.

04 May 2018

New endpoints

Keywords

Ads

  • GET
    /ads
    : Retrieve the statistics of some ads.

Improved endpoints

Campaigns

  • GET
    /campaigns
    : A feature to support formulas as been added in preview (not considered stable yet).

26 April 2018

New endpoints

Accounts

Ad Platform Accounts

Campaigns

Ad Groups