Report Specification for CRM
General Description
The report contains information about advertising campaigns on the M-SQ platform, including the status of advertisements and view metrics. The report is presented in XML format.Attributes
- generation-date: Date and time of report generation in ISO 8601 format.
XML Structure
Root Element
- offers: Root element containing the
generation-dateattribute and one or moreofferelements.
Elements within <offers>
- offer: Element containing information about a specific advertisement. It may include the following sub-elements:
- id: Unique advertisement number on M-SQ. May be absent. - url: Link to the advertisement on M-SQ. May be absent. - externalid: Unique CRM number from an external system (feed). - status: Advertisement status. Possible values:
- `error`: Error.
- `finish`: Finished.
- `published`: Published.Example XML Report
<offers generation-date="2024-06-20T06:00:08+00:00">
<offer>
<url>https://m-sq.eu/offer/1</url>
<id>1</id>
<external_id>R474</external_id>
<status>published</status>
<view>123</view>
<view_tel>7</view_tel>
</offer>
<offer>
<external_id>277</external_id>
<status>error</status>
<message>The location of the object could not be determined; You must indicate your locality in the ad;</message>
</offer>
</offers>Notes
- Elements
url,id,message,view, andview_telmay be absent depending on the advertisement status and availability of corresponding data. - Status
errormay be accompanied by themessageelement to describe the error. - The
messageelement contains errors listed separated via;, mainly in English unless the language is undefined