GET ​/api​/v3​/advertisements

Returns a list of advertisements

Request

Example Request

{
}

Example Parameters

Response

Example Response

{
  "advertisements": [
    {
      "id": 1,
      "title": "Everyone loves an ad",
      "tracked_link_url": "http://example.com",
      "vertical_advertisement_url": "http://example.com/image.jpg"
    }
  ]
}

Response Parameters

  • advertisements: A list of the advertisements

    • Required: no
    • Type: array
    • Items

      • Required: no
      • id: The server id of the advertisement
        • Required: no
        • Type: integer
        • Example: 1
      • title: A title for the ad
        • Required: no
        • Type: string
        • Example: Everyone loves an ad
      • trackedlinkurl: A tracked link to display when the image is clicked
        • Required: no
        • Type: string
        • Format: uri
        • Example: http://example.com
      • verticaladvertisementurl: The url to the advertisement image
        • Required: no
        • Type: string
        • Example: http://example.com/image.jpg

Response Codes

Successful Response Codes

  • 200:

Failure Response Codes