Get List of Available Reports

Use this operation to retrieve a list of the Deact reports that are available to fetch.

This endpoint is also used for retrieving the reports.

Quick facts

Method

GET

Returns

CSV

Prerequisites

Your account must be provisioned for SMS

More information

See Overview.

Making a request

Definition

GET https://deact.openmarket.com/deact/v1/report?

Header fields

You must provide your authentication details using Basic authentication in the header.

Important: Use a user account username and password rather than application account credentials. In addition, this API accepts only HTTPS with TLS 1.1 or higher.

For example:

GET /deact/v1/report HTTPS/1.1
Host: deact.openmarket.com
Authorization: Basic VXNlcm5hbWU6cGFzc3dvcmQ=

Field

Description

Authorization

Your account ID and password, separated by a colon, and then base64 encoded. Your account ID and password are case-sensitive. For help with Basic authentication see Authenticate with OpenMarket.

Required: Always

Example request 

GET https://deact.openmarket.com/deact/v1/report?

Response from OpenMarket

Accepted requests

If your request is accepted then OpenMarket sends a response with XML in the response body.

<?xml version="1.0" encoding="UTF-8"?>
<reports>
   <report deactFileName="interop-deacts" size="194" generatedDate="2018-10-16T20:30:36Z" deletionDate="2018-12-14T07:15:28Z" startDate="2018-10-13T07:15:28Z" endDate="2018-10-14T07:15:28Z" s3Id="fd0b6c5a-e3e0-4bd9-9388-a6e362f4fb8f" detailLevel="ITEMIZED" status="PROCESSED" dataSource="deact">
      <categories>
         <category>DEACT</category>
      </categories>
      <format>CSV</format>
   </report>
</reports>