Jump to

• Request
• Response

Get Track & Campaign name info for a utility

get

/apis/programDesign-v1/v1/utilities/{utilityCode}/tracks/names

Returns a list of tracks and campaigns with their corresponding ids and names.

Request

Path Parameters

• utilityCode(required): string
  A 3- or 4-character representation of the client code. Valid examples - "UTIL" and "util"

Back to Top

Response

200 Response

A list of tracks/campaigns with theirs ids and names

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object PublicTrackInfo

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/PublicTrackInfo"
    }
}

Nested Schema : PublicTrackInfo

Type: object

Show Source

• tracks: array tracks
  A list of tracks and their campaigns

{
    "type":"object",
    "properties":{
        "tracks":{
            "description":"A list of tracks and their campaigns",
            "type":"array",
            "example":{
                "id":"accf6cf2-66c8-11e9-a923-1681be663d3e",
                "name":"2018 HIGH ENERGY USERS",
                "campaigns":{
                    "id":183608,
                    "name":"INTRO EXPERIENCE"
                }
            },
            "items":{
                "$ref":"#/definitions/CampaignInfo"
            }
        }
    },
    "required":[
        "id",
        "name",
        "campaigns"
    ]
}

Nested Schema : tracks

Type: array

A list of tracks and their campaigns

Show Source

• Array of: object CampaignInfo

{
    "description":"A list of tracks and their campaigns",
    "type":"array",
    "example":{
        "id":"accf6cf2-66c8-11e9-a923-1681be663d3e",
        "name":"2018 HIGH ENERGY USERS",
        "campaigns":{
            "id":183608,
            "name":"INTRO EXPERIENCE"
        }
    },
    "items":{
        "$ref":"#/definitions/CampaignInfo"
    }
}

Example:

{
    "id":"accf6cf2-66c8-11e9-a923-1681be663d3e",
    "name":"2018 HIGH ENERGY USERS",
    "campaigns":{
        "id":183608,
        "name":"INTRO EXPERIENCE"
    }
}

Nested Schema : CampaignInfo

Type: object

Show Source

• id(required): integer(int64)
• name(required): string

{
    "properties":{
        "id":{
            "type":"integer",
            "format":"int64"
        },
        "name":{
            "type":"string"
        }
    },
    "required":[
        "id",
        "name"
    ]
}

400 Response

Bad utility code

Back to Top