Status API (UAS)

Document created by pubmatic-archivist on Mar 27, 2017Last modified by catherine.racette on Aug 29, 2017
Version 7Show Document
  • View in full screen mode

Description

In the Unified Ad Server, every entity such as Ad Unit, Ad Unit Group, Order, Line Item, et.c has a status attribute. Use this API to retrieve the available status in the Unified Ad Server.

Note: Not all statuses listed by API is applicable to each entity. Please check the respective entity API to check if the status value is supported or not.

Supported Operations

Service Name: /status/

                           

Method PathHTTP Method TypeDescriptionLink to Definition
/status/{id}GETRetrieve the details of a specific status for a requested status id.Retrieve the Details of a Status
/status/GET

Retrieve a list of statuses supported in the Unified Ad Server.

You can apply supported dimensions, filters and sorting options by macro service to retrieve a list of macros with a specific set of details as needed.

Retrieve a List of Statuses
/status?/dimensions=id,name&sort=idGETRetrieves the details of the macro with the dimensions and filters used.Generic Search

 

Retrieve the Details of a Status

Overview

This API retrieves the details of the specified Status.

Request

           

Request Headers

                        

Header nameType ValueRequiredDescription
Content-TypeStringapplication/jsonYesMedia type for request.
pubTokenString${access_token}Yes

Publisher Token to authenticate and authorize the user calling the Unified Ad Server API. Send the access token generated for authentication at the place of ${access_token} in the request.

 

For more information about access tokens, refer to Getting Started with PubMatic APIs.

 

Request URL

https://api.pubmatic.com/v1/uas/status/1 

Response

                       

Parameter NameTypeDescription
idNumericStatus Identifier
nameStringStatus Name
descriptionStringDescription for the Status

Sample Response JSON

    

{
  "id": 1,
  "name": "Active"
}

 

Retrieve a List of Statuses

Overview

This API retrieves a list of supported Statuses.

Request

           

Request Headers

                        

Header nameType ValueRequiredDescription
Content-TypeStringapplication/jsonYesMedia type for request.
pubTokenString${access_token}Yes

Publisher Token to authenticate and authorize the user calling the Unified Ad Server API. Send the access token generated for authentication at the place of ${access_token} in the request.

 

Request URL

https://api.pubmatic.com/v1/uas/status/ 

Response

                       

Parameter NameTypeDescription
idNumericStatus Identifier
nameStringStatus Name
descriptionStringDescription for the Status

Sample Response JSON

    

It will return a list of all supported statuses.

 

Generic Search

Overview

This API retrieves a list of supported Statuses that match the specified dimensions and filters.

For more information on dimensions and filters, refer to Common Request Query Parameters.

Request

           

Request Headers

                        

Header nameType ValueRequiredDescription
Content-TypeStringapplication/jsonYesMedia type for request.
pubTokenString${access_token}Yes

Publisher Token to authenticate and authorize the user calling the Unified Ad Server API. Send the access token generated for authentication at the place of ${access_token} in the request.

 

For more information about access tokens, refer to Getting Started with PubMatic APIs.

 

Request URL

https://api.pubmatic.com/v1/uas/status?dimensions=id,name&sort=id 

Response

                       

Parameter NameTypeDescription
idNumericStatus Identifier
nameStringStatus Name
descriptionStringDescription for the Status

Sample Response JSON

    

It will return a list of all statuses associated with your account that match the specified dimensions and filters.

Error Codes for Status

             

Sr. NoError CodesDescription
1MISSING_OR_INVALID_PARAMETERRequested a status with an id that does not exist or is invalid.

 

Unified Ad Server References

Common Request Query Parameters for Web Services

Supported Operations for Filters

HTTP Status Codes

Unified Ad Server Specific Error Codes

 

 

Version 0.1

Attachments

    Outcomes