Contents x
    Search campaigns
      • Print
      Contents

      Search campaigns

        • Print
        Article summary

        Get
        /v2/{accessKey}/campaign
        Header parameters
        Authorization
        stringRequired

        Authorization: Bearer

        Path parameters
        accessKey
        stringRequired

        Customer access key

        Query parameters
        from
        string

        Search campaigns between FROM and TO of scheduledStartAt date range (format: YYYY-MM-DD'T'HH:mm:ss'Z', e.g. 2022-05-20T08:00:00Z)

        to
        string

        Search campaigns between FROM and TO of scheduledStartAt date range (format: YYYY-MM-DD'T'HH:mm:ss'Z', e.g. 2022-05-20T09:00:00Z)

        keyword
        string

        Keyword to search title and description of campaigns

        tags
        string

        Comma separated tags for search. Pleas use tagSearchOperator to specify AND or OR query.

        tagSearchOperator
        string

        Please specify search operator when searching by tags

        campaignStatus
        string

        Status(READY, REHEARSAL, ONAIR, ENDED). Case-insensitive.

        sellerId
        integer (int32)

        Seller's id to search.

        campaignIds
        string

        Search by campaign IDs. You can enter multiple IDs separated by commas, e.g., 1234,1235,1236.

        campaignKeys
        string

        Search by campaign keys instead of campaignIds. You can enter multiple campaign keys separated by commas, e.g., c7671aa83bd2,6229da3b75d4.

        sortAscending
        boolean

        Sort the result of the query

        Defaultfalse
        page
        integer (int32)

        Parameter for pagination. Default is 1.

        Default1
        count
        integer (int32)

        Specify the number of the result in one page (max : 20)

        Default10
        Responses
        200

        200

        Result
        "{\n    \"results\": [\n        {\n            \"campaignMeta\": {\n                \"campaignId\": \"1237\",\n                \"campaignKey\": \"{campaignKey}\",\n                \"accessKey\": \"{accessKey}\",\n                \"shoplivePlayerUrl\": \"https://www.shoplive.show/v1/player.html?ak={accessKey}&ck={campaignKey}\",\n                \"title\": \"Shoplive Ready Liveshow\",\n                \"description\": \"Liveshow Ready description\",\n                \"campaignStatus\": \"READY\",\n                \"rehearsalPasscode\": \"9876\",\n                \"serveReplay\": false,\n                \"logoImageUrl\": null,\n                \"preCampaignVideoUrl\": null,\n                \"preCampaignImageUrl\": \"https://image.shoplive.cloud/14352cf2-ef40-4ba9-93af-279a104cb3c8.png\",\n                \"postCampaignImageUrl\": \"https://image.shoplive.cloud/6da19c2d-8d53-4cea-801f-7b39913f7c35.png\",\n                \"backgroundImageUrl\": \"https://image.shoplive.cloud/0b1bd566-4087-40ef-b376-fb863a888d72.png\",\n                \"ieUnsupportImageUrl\": \"https://image.shoplive.cloud/5a0fd01c-8889-4d28-8a15-8b7661a422a2.png\",\n                \"scheduledStartAt\": \"2022-11-01T09:00:00Z\",\n                \"scheduledEndAt\": \"2022-11-01T10:00:00Z\",\n                \"campaignStartedAt\": null,\n                \"campaignEndedAt\": null,\n                \"createdAt\": \"2022-11-01T08:15:00Z\",\n                \"updatedAt\": \"2022-11-01T08:29:09Z\"\n            },\n            \"stream\": {\n                \"streamUrl\": \"rtmp://stream.shoplive.cloud:1935/stream\",\n                \"streamKey\": \"{streamKey}\",\n                \"videoAspectRatio\": \"9:16\",\n                \"liveUrl\": \"https://live.shoplive.cloud/live/{streamKey}.m3u8\",\n       \"liveUrls\": {\n        \"480p\": \"https://live.shoplive.cloud/live/{streamKey}_480p/playlist.m3u8\",\n        \"720p\": \"https://live.shoplive.cloud/live/{streamKey}_720p/playlist.m3u8\"\n        },\n                             \"previewLiveUrl\": \"https://live.shoplive.cloud/live/{streamKey}_320p/index.m3u8\",\n                \"replayLiveUrl\": null,\n        \"replayLiveUrls\": null,\n                \"previewReplayLiveUrl\": \"https://api.shoplive.cloud/v1/replay/{accessKey}/{campaignKey}/replay_320p/ORIGINAL/index.m3u8\"\n            },\n            \"seller\": {\n                \"sellerId\": \"1\",\n                \"name\": \"Shoplive Product Store\",\n                \"profileUrl\": \"https://image.shoplive.cloud/7910e586-19a4-4740-804b-5f9da02e6939.jpg\",\n                \"storeUrl\": \"https://shoplive.cloud\",\n                \"schemes\": null\n            }\n        },\n      {\n            \"campaignMeta\": {\n                \"campaignId\": \"1236\",\n                \"campaignKey\": \"{campaignKey}\",\n                \"accessKey\": \"{accessKey}\",\n                \"shoplivePlayerUrl\": \"https://www.shoplive.show/v1/player.html?ak={accessKey}&ck={campaignKey}\",\n                \"title\": \"Shoplive Liveshow Rehearsal\",\n                \"description\": \"Liveshow Rehearsal description\",\n                \"campaignStatus\": \"REHEARSAL\",\n                \"rehearsalPasscode\": \"9876\",\n                \"serveReplay\": false,\n                \"logoImageUrl\": null,\n                \"preCampaignVideoUrl\": null,\n                \"preCampaignImageUrl\": \"https://image.shoplive.cloud/14352cf2-ef40-4ba9-93af-279a104cb3c8.png\",\n                \"postCampaignImageUrl\": \"https://image.shoplive.cloud/6da19c2d-8d53-4cea-801f-7b39913f7c35.png\",\n                \"backgroundImageUrl\": \"https://image.shoplive.cloud/0b1bd566-4087-40ef-b376-fb863a888d72.png\",\n                \"ieUnsupportImageUrl\": \"https://image.shoplive.cloud/5a0fd01c-8889-4d28-8a15-8b7661a422a2.png\",\n                \"scheduledStartAt\": \"2022-10-31T09:00:00Z\",\n                \"scheduledEndAt\": \"2022-10-31T10:00:00Z\",\n                \"campaignStartedAt\": null,\n                \"campaignEndedAt\": null,\n                \"createdAt\": \"2022-10-31T08:15:00Z\",\n                \"updatedAt\": \"2022-10-31T08:29:09Z\"\n            },\n            \"stream\": {\n                \"streamUrl\": \"rtmp://stream.shoplive.cloud:1935/stream\",\n                \"streamKey\": \"{streamKey}\",\n                \"videoAspectRatio\": \"9:16\",\n                \"liveUrl\": \"https://live.shoplive.cloud/live/{streamKey}.m3u8\",\n       \"liveUrls\": {\n        \"480p\": \"https://live.shoplive.cloud/live/{streamKey}_480p/playlist.m3u8\",\n        \"720p\": \"https://live.shoplive.cloud/live/{streamKey}_720p/playlist.m3u8\"\n        },\n                             \"previewLiveUrl\": \"https://live.shoplive.cloud/live/{streamKey}_320p/index.m3u8\",\n                \"replayLiveUrl\": null,\n        \"replayLiveUrls\": null,\n                \"previewReplayLiveUrl\": \"https://api.shoplive.cloud/v1/replay/{accessKey}/{campaignKey}/replay_320p/ORIGINAL/index.m3u8\"\n            },\n            \"seller\": {\n                \"sellerId\": \"1\",\n                \"name\": \"Shoplive Product Store\",\n                \"profileUrl\": \"https://image.shoplive.cloud/7910e586-19a4-4740-804b-5f9da02e6939.jpg\",\n                \"storeUrl\": \"https://shoplive.cloud\",\n                \"description\": \"Description of the seller\",\n                \"schemes\": null\n            }\n        },\n        {\n            \"campaignMeta\": {\n                \"campaignId\": \"1235\",\n                \"campaignKey\": \"{campaignKey}\",\n                \"accessKey\": \"{accessKey}\",\n                \"shoplivePlayerUrl\": \"https://www.shoplive.show/v1/player.html?ak={accessKey}&ck={campaignKey}\",\n                \"title\": \"Shoplive Liveshow OnAir\",\n                \"description\": \"Liveshow OnAir description\",\n                \"campaignStatus\": \"ONAIR\",\n                \"rehearsalPasscode\": \"9876\",\n                \"serveReplay\": false,\n                \"logoImageUrl\": null,\n                \"preCampaignVideoUrl\": null,\n                \"preCampaignImageUrl\": \"https://image.shoplive.cloud/14352cf2-ef40-4ba9-93af-279a104cb3c8.png\",\n                \"postCampaignImageUrl\": \"https://image.shoplive.cloud/6da19c2d-8d53-4cea-801f-7b39913f7c35.png\",\n                \"backgroundImageUrl\": \"https://image.shoplive.cloud/0b1bd566-4087-40ef-b376-fb863a888d72.png\",\n                \"ieUnsupportImageUrl\": \"https://image.shoplive.cloud/5a0fd01c-8889-4d28-8a15-8b7661a422a2.png\",\n                \"scheduledStartAt\": \"2022-10-30T09:00:00Z\",\n                \"scheduledEndAt\": \"2022-10-30T10:00:00Z\",\n                \"campaignStartedAt\": \"2022-10-30T09:10:05Z\",\n                \"campaignEndedAt\": null,\n                \"createdAt\": \"2022-10-30T08:15:00Z\",\n                \"updatedAt\": \"2022-10-30T08:29:09Z\"\n            },\n            \"stream\": {\n                \"streamUrl\": \"rtmp://stream.shoplive.cloud:1935/stream\",\n                \"streamKey\": \"{streamKey}\",\n                \"videoAspectRatio\": \"9:16\",\n                \"liveUrl\": \"https://live.shoplive.cloud/live/{streamKey}.m3u8\",\n       \"liveUrls\": {\n        \"480p\": \"https://live.shoplive.cloud/live/{streamKey}_480p/playlist.m3u8\",\n        \"720p\": \"https://live.shoplive.cloud/live/{streamKey}_720p/playlist.m3u8\"\n        },\n                             \"previewLiveUrl\": \"https://live.shoplive.cloud/live/{streamKey}_320p/index.m3u8\",\n                \"replayLiveUrl\": null,\n        \"replayLiveUrls\": null,\n                \"previewReplayLiveUrl\": \"https://api.shoplive.cloud/v1/replay/{accessKey}/{campaignKey}/replay_320p/ORIGINAL/index.m3u8\"\n            },\n            \"seller\": {\n                \"sellerId\": \"1\",\n                \"name\": \"Shoplive Product Store\",\n                \"profileUrl\": \"https://image.shoplive.cloud/7910e586-19a4-4740-804b-5f9da02e6939.jpg\",\n                \"storeUrl\": \"https://shoplive.cloud\",\n                \"description\": \"Description of the seller\",\n                \"schemes\": null\n            }\n        },\n        {\n            \"campaignMeta\": {\n                \"campaignId\": \"1234\",\n                \"campaignKey\": \"{campaignKey}\",\n                \"accessKey\": \"{accessKey}\",\n                \"shoplivePlayerUrl\": \"https://www.shoplive.show/v1/player.html?ak={accessKey}&ck={campaignKey}\",\n                \"title\": \"Shoplive Liveshow\",\n                \"description\": \"Liveshow description\",\n                \"campaignStatus\": \"ENDED\",\n                \"rehearsalPasscode\": \"9876\",\n                \"serveReplay\": true,\n                \"logoImageUrl\": null,\n                \"preCampaignVideoUrl\": null,\n                \"preCampaignImageUrl\": \"https://image.shoplive.cloud/14352cf2-ef40-4ba9-93af-279a104cb3c8.png\",\n                \"postCampaignImageUrl\": \"https://image.shoplive.cloud/6da19c2d-8d53-4cea-801f-7b39913f7c35.png\",\n                \"backgroundImageUrl\": \"https://image.shoplive.cloud/0b1bd566-4087-40ef-b376-fb863a888d72.png\",\n                \"ieUnsupportImageUrl\": \"https://image.shoplive.cloud/5a0fd01c-8889-4d28-8a15-8b7661a422a2.png\",\n                \"scheduledStartAt\": \"2022-10-29T09:00:00Z\",\n                \"scheduledEndAt\": \"2022-10-29T10:00:00Z\",\n                \"campaignStartedAt\": \"2022-10-29T09:10:05Z\",\n                \"campaignEndedAt\": \"2022-10-29T10:05:05Z\",\n                \"createdAt\": \"2022-10-29T08:15:00Z\",\n                \"updatedAt\": \"2022-10-29T08:29:09Z\"\n            },\n            \"stream\": {\n                \"streamUrl\": \"rtmp://stream.shoplive.cloud:1935/stream\",\n                \"streamKey\": \"{streamKey}\",\n                \"videoAspectRatio\": \"9:16\",\n                \"liveUrl\": \"https://live.shoplive.cloud/live/{streamKey}.m3u8\",\n       \"liveUrls\": {\n        \"480p\": \"https://live.shoplive.cloud/live/{streamKey}_480p/playlist.m3u8\",\n        \"720p\": \"https://live.shoplive.cloud/live/{streamKey}_720p/playlist.m3u8\"\n        },\n                             \"previewLiveUrl\": \"https://live.shoplive.cloud/live/{streamKey}_320p/index.m3u8\",\n                \"replayLiveUrl\": \"https://private.shopliveapi.com/v1/replay/{accessKey}/{campaignKey}/replay.m3u8?replayMode=ORIGINAL\",\n        \"replayLiveUrls\": {\n                \"480p\": \"https://private.shopliveapi.com/v1/replay/{accessKey}/{campaignKey}/ORIGINAL/480p/index.m3u8\",\n                \"720p\": \"https://private.shopliveapi.com/v1/replay/{accessKey}/{campaignKey}/ORIGINAL/720p/index.m3u8\"\n            },\n                        \"previewReplayLiveUrl\": \"https://api.shoplive.cloud/v1/replay/{accessKey}/{campaignKey}/replay_320p/ORIGINAL/index.m3u8\"\n            },\n            \"seller\": {\n                \"sellerId\": \"1\",\n                \"name\": \"Shoplive Product Store\",\n                \"profileUrl\": \"https://image.shoplive.cloud/7910e586-19a4-4740-804b-5f9da02e6939.jpg\",\n                \"storeUrl\": \"https://shoplive.cloud\",\n                \"description\": \"Description of the seller\",\n                \"schemes\": null\n            }\n        }\n    ],\n    \"totalCount\": 4\n}"
        Expand All
        object
        results
        Array of object
        object
        campaignMeta
        object
        campaignId
        string
        Example1237
        campaignKey
        string
        Example{campaignKey}
        accessKey
        string
        Example{accessKey}
        shoplivePlayerUrl
        string
        Examplehttps://www.shoplive.show/v1/player.html?ak={accessKey}&ck={campaignKey}
        title
        string
        ExampleShoplive Ready Liveshow
        description
        string
        ExampleLiveshow Ready description
        tags
        Array
        Examplecomma separated tags
        campaignStatus
        string
        ExampleREADY
        rehearsalPasscode
        string
        Example9876
        serveReplay
        boolean
        Defaulttrue
        ExampleFalse
        logoImageUrl
        preCampaignVideoUrl
        preCampaignImageUrl
        string
        Examplehttps://image.shoplive.cloud/14352cf2-ef40-4ba9-93af-279a104cb3c8.png
        postCampaignImageUrl
        string
        Examplehttps://image.shoplive.cloud/6da19c2d-8d53-4cea-801f-7b39913f7c35.png
        backgroundImageUrl
        string
        Examplehttps://image.shoplive.cloud/0b1bd566-4087-40ef-b376-fb863a888d72.png
        ieUnsupportImageUrl
        string
        Examplehttps://image.shoplive.cloud/5a0fd01c-8889-4d28-8a15-8b7661a422a2.png
        scheduledStartAt
        string
        Example2022-11-01T09:00:00Z
        scheduledEndAt
        string
        Example2022-11-01T10:00:00Z
        campaignStartedAt
        campaignEndedAt
        createdAt
        string
        Example2022-11-01T08:15:00Z
        updatedAt
        string
        Example2022-11-01T08:29:09Z
        stream
        object
        streamUrl
        string
        Examplertmp://stream.shoplive.cloud:1935/stream
        streamKey
        string
        Example{streamKey}
        videoAspectRatio
        string
        Example9:16
        liveUrl
        string
        Examplehttps://live.shoplive.cloud/live/{streamKey}.m3u8
        liveUrls
        object
        480p
        string
        Examplehttps://live.shoplive.cloud/live/{streamKey}_480p/playlist.m3u8
        720p
        string
        Examplehttps://live.shoplive.cloud/live/{streamKey}_720p/playlist.m3u8
        previewLiveUrl
        string
        Examplehttps://live.shoplive.cloud/live/{streamKey}_320p/index.m3u8
        replayLiveUrl
        replayLiveUrls
        previewReplayLiveUrl
        string
        Examplehttps://api.shoplive.cloud/v1/replay/{accessKey}/{campaignKey}/replay_320p/ORIGINAL/index.m3u8
        seller
        object
        sellerId
        string
        Example1
        name
        string
        ExampleShoplive Product Store
        profileUrl
        string
        Examplehttps://image.shoplive.cloud/7910e586-19a4-4740-804b-5f9da02e6939.jpg
        storeUrl
        string
        Examplehttps://shoplive.cloud
        schemes
        totalCount
        integer
        Default0
        Example4
        4XX

        4XX

        Result
        "{\n    \"_s\": -000,\n    \"_e\": \"Error message\"\n}"
        What's Next