Publisher API
List Sponsorships
1 min
{ "tab" "examples", "url" "https //api paved com/publisher/v1/newsletters/{slug}/sponsorships", "name" "list sponsorships", "method" "get", "request" { "pathparameters" \[ { "kind" "required", "name" "slug", "type" "string", "children" \[], "description" "your newsletter slug" } ], "queryparameters" \[ { "kind" "optional", "name" "from date", "type" "string", "children" \[], "description" "format yyyy mm dd iso8601\nall times are in utc" }, { "kind" "optional", "name" "to date", "type" "string", "children" \[], "description" "format yyyy mm dd iso8601\nall times are in utc" }, { "kind" "optional", "name" "limit", "type" "integer", "children" \[], "description" "default 20\nmaximum 100" }, { "kind" "optional", "name" "include creative", "type" "boolean", "children" \[], "description" "include sponsorship creative" }, { "kind" "optional", "name" "include reporting", "type" "boolean", "children" \[], "description" "include sponsorship reporting stats " } ], "headerparameters" \[ { "kind" "required", "name" "authorization", "type" "string", "children" \[], "description" "" } ], "bodydataparameters" \[], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "umbyziigg ghv1cxambin", "code" "\[\n {\n \\"id\\" \\"123abc\\",\n \\"advertiser name\\" \\"acme inc\\",\n \\"status\\" \\"sent\\",\n \\"run date\\" \\"2023 01 24\\",\n \\"price\\" \\"1200 00\\",\n \\"sponsorship option name\\" \\"header placement\\",\n \\"sponsorship option id\\" \\"123abd\\"\n },\n {\n \\"id\\" \\"123def\\",\n \\"advertiser name\\" \\"amce inc\\",\n \\"status\\" \\"creative\\",\n \\"run date\\" \\"2023 03 14\\",\n \\"price\\" \\"2303 0\\",\n \\"sponsorship option name\\" \\"footer placement\\",\n \\"sponsorship option id\\" \\"123deg\\"\n }\n]", "language" "200", "customlabel" "" }, { "id" "yc1nelkltmzh5znnnafyw", "code" "", "language" "404", "customlabel" "" } ], "selectedlanguageid" "umbyziigg ghv1cxambin" }, "examples" { "languages" \[ { "id" "36ee2kjk6x3lrjkunbsov", "code" "curl location g request get 'https //api paved com/publisher/v1/newsletters/{slug}/sponsorships?from date=string\&to date=string\&limit=integer\&include creative=boolean\&include reporting=boolean' \\\\\n header 'accept application/json' \\\\\n header 'authorization token xx'", "language" "curl", "customlabel" "" }, { "id" "wjdm0jgq8aubhivopy4ci", "code" "var request = require('request');\nvar options = {\n 'method' 'get',\n 'url' 'https //api paved com/publisher/v1/newsletters/{slug}/sponsorships?from date=string\&to date=string\&limit=integer\&include creative=boolean\&include reporting=boolean',\n 'headers' {\n 'accept' 'application/json',\n 'authorization' 'token xx'\n }\n};\nrequest(options, function (error, response) {\n if (error) throw new error(error);\n console log(response body);\n});\n", "language" "nodejs", "customlabel" "" }, { "id" "pgrc4ryd9fdcddfsshtei", "code" "var myheaders = new headers();\nmyheaders append(\\"accept\\", \\"application/json\\");\nmyheaders append(\\"authorization\\", \\"token xx\\");\n\nvar requestoptions = {\n method 'get',\n headers myheaders,\n redirect 'follow'\n};\n\nfetch(\\"https //api paved com/publisher/v1/newsletters/{slug}/sponsorships?from date=string\&to date=string\&limit=integer\&include creative=boolean\&include reporting=boolean\\", requestoptions)\n then(response => response text())\n then(result => console log(result))\n catch(error => console log('error', error));", "language" "javascript", "customlabel" "" }, { "id" "armfke54sqvwop7rxqnzw", "code" "import requests\n\nurl = \\"https //api paved com/publisher/v1/newsletters/{slug}/sponsorships?from date=string\&to date=string\&limit=integer\&include creative=boolean\&include reporting=boolean\\"\n\npayload={}\nheaders = {\n 'accept' 'application/json',\n 'authorization' 'token xx'\n}\n\nresponse = requests request(\\"get\\", url, headers=headers, data=payload)\n\nprint(response text)\n", "language" "python", "customlabel" "" }, { "id" "lslmjpzkq1yxfmjf3qtff", "code" "require \\"uri\\"\nrequire \\"net/http\"\n\nurl = uri(\\"https //api paved com/publisher/v1/newsletters/{slug}/sponsorships?from date=string\&to date=string\&limit=integer\&include creative=boolean\&include reporting=boolean\\")\n\nhttps = net http new(url host, url port)\nhttps use ssl = true\n\nrequest = net http get new(url)\nrequest\[\\"accept\\"] = \\"application/json\\"\nrequest\[\\"authorization\\"] = \\"token xx\\"\n\nresponse = https request(request)\nputs response read body\n", "language" "ruby", "customlabel" "" } ], "selectedlanguageid" "36ee2kjk6x3lrjkunbsov" }, "description" "retrieve information about all your sponsorships ", "currentnewparameter" { "label" "query parameter", "value" "queryparameters" } }