"}],"body":{"mode":"graphql","graphql":{"query":"mutation {\n updatePartnerLineItem(lineItemId: \"8234\", lineItemInput: {\n name: \"Updated line item name\",\n endTime: \"2021-07-18 24:14:20\",\n timeOfDay: {\n include: [\n {\n time: [\"12:00\", \"00:00\"],\n days: [\"monday\",\"tuesday\"]\n },\n {\n time: [\"12:00\", \"15:00\"],\n days: [\"saturday\",\"sunday\"]\n }\n ],\n exclude: [\n {\n days: [\"friday\"]\n }\n ],\n },\n timeZone: \"CDT\",\n kvTargeting: {\n CUSTOM_COUNTRY:{\n include:[\"41729\"],\n exclude:[]\n },\n CUSTOM_DMA: {\n include:[],\n exclude:[]\n },\n CUSTOM_STATE: {\n include:[\"41736\"],\n exclude:[]\n },\n CUSTOM_AUD_SEGMENT: {\n include:[\"75003\", \"75008\"],\n exclude:[]\n }\n },\n bid: {\n currency: \"0\",\n bidRate: \"10\",\n pricingType: \"99\",\n budgetType: \"8\",\n budgetAmount: \"100\"\n },\n modifier: {\n newsfeed: \"0.2\",\n fsf: \"-0.2\"\n }\n }, clientId: \"\"){\n id\n name\n status\n creativeIds\n bid {\n bidStrategy\n bidMicroValue\n currency {\n name\n code\n }\n dailyCap\n maxCap\n }\n modifier {\n newsfeed\n fsf\n }\n priority\n campaignId\n startTime\n endTime\n timeCreated\n timeEdited\n timeZone\n }\n}","variables":""}},"url":"https://ads.nextdoor-test.com/graphql/api/v1","description":"Updates a line item.
\nRequest Arguments
\n\n\n\n| Argument | \nDescription | \n
\n\n\n\n| lineItemId | \nID of line item to update | \n
\n\n| lineItemInput | \nUpdated properties of the line item | \n
\n\n| clientId | \nClient ID | \n
\n\n
\n
\n\n\n| Parameter | \nDescription | \nRequired | \n
\n\n\n\n| name | \nLine item name | \nOptional | \n
\n\n| endTime | \nDate & time that line item should stop serving | \nOptional | \n
\n\n| timeOfDay | \nTimes of day that the line item is permitted to serve | \nOptional | \n
\n\n| timeZone | \nThe time zone used for the startTime, endTime, and timeOfDay parameters | \nOptional | \n
\n\n| kvTargeting | \nTargeting key-values | \nOptional | \n
\n\n| bid | \nThe line item's bid | \nOptional | \n
\n\n| modifier | \nModifiers (adjustments) to the line item bid | \nOptional | \n
\n\n
\n
Important Notes:
\n\nendTime must have the following format: YYYY-MM-DD HH:MM:SS - If an empty object is passed as the
timeOfDay, the line item will serve at all times. Please refer to the example below to see how to get line items to run at specific hours and days using the timeOfDay parameter. \n
\nTargeting
\n[TARGETING NOT YET READY FOR USE. SUPPORT WILL BE ADDED SOON]
\nLine items may be targeted by: state, designated market area (DMA), and/or audience segment. To add targeting, you must list the IDs of the targeting values that you would like to set. Please refer to the example below for more details on how to add targeting to a line item using the kvTargeting parameter.
\nFor a list of all the targeting key-values, please visit the following link.
\nNOTE: We do not yet support targeting by country. All newly created line items are targeted to the U.S. by default.
\nUpdating the bid
\nTo update the bid of a line item, an object with all of the following properties must be provided:
\n\n\n\n| Property | \nDescription | \nPossible Values | \n
\n\n\n\n| currency | \nThe currency used for bids | \n0 (USD) | \n
\n\n| pricingType | \nThe type of pricing used for bids | \n99 (CPM), 98 (CPC) | \n
\n\n| bidRate | \nThe maximum bid amount, i.e. the most you are willing to pay per click (if CPC pricingType selected) or per 1,000 impressions (if CPM pricingType selected) | \n | \n
\n\n| budgetType | \nThe type of budget set for bidding | \n8 (Daily budget) or 9 (Lifetime budget) | \n
\n\n| budgetAmount | \nThe budget amount | \n | \n
\n\n
\n
Adding bid modifiers (adjustments)
\nYou can increase or decrease the bid of a line item depending on whether it is being auctioned for the newsfeed or the for sale & free section. To do so, pass an object with the following properties into the modifier parameter.
\n\n\n\n| Property | \nDescription | \nPossible Values | \n
\n\n\n\n| newsfeed | \nBid modifier for newsfeed | \n-0.5 (decrease by 50%) to 0.5 (increase by 50%) | \n
\n\n| fsf | \nBid modifier for the for sale & free section | \n-0.5 (decrease by 50%) to 0.5 (increase by 50%) | \n
\n\n
\n
Possible values for timeZone
\n\n\n\n| Value | \nDescription | \n
\n\n\n\n| EDT | \nEastern Daylight Time | \n
\n\n| CDT | \nCentral Daylight Time | \n
\n\n| MDT | \nMountain Daylight Time | \n
\n\n| AKDT | \nAlaska Daylight Time | \n
\n\n| HST | \nHawaii Standard Time | \n
\n\n
\n
Response Fields
\n\n\n\n| Field | \nDescription | \n
\n\n\n\n| id | \nLine item ID | \n
\n\n| name | \nLine item name | \n
\n\n| status | \nThe status of the line item (ex. \"Live\", \"Deleted\", \"Paused\") | \n
\n\n| creativeIds | \nIDs of the creatives associated with line item | \n
\n\n| bid | \nThe line item's bid | \n
\n\n| modifier | \nModifiers (adjustments) to the line item bid | \n
\n\n| priority | \nA number from 4-16 representing the line item's priority (the lower the number, the higher the priority) | \n
\n\n| campaignId | \nID of campaign that line item was added to | \n
\n\n| startTime | \nDate & time that line item should start serving | \n
\n\n| endTime | \nDate & time that line item should stop serving | \n
\n\n| timeCreated | \nDate & time that line item was created | \n
\n\n| timeEdited | \nDate & time that line item was last updated | \n
\n\n| timeZone | \nTime zone | \n
\n\n
\n
Possible values for status
\n\nDraftLivePausedDeletedPending ApprovalDisapprovedCompletedInactive
\nBid Response Fields
\nThe bid object that is returned in the response has different fields from the bid object that can be optionally provided as input when updating a line item. The following are the fields returned in the bid object contained in the response:
\n\n\n\n| Field | \nDescription | \n
\n\n\n\n| bidMicroValue | \nThe bid amount (adjusted based on the bid modifier) divided by 1 million | \n
\n\n| currency | \nThe currency for the line item bid | \n
\n\n| dailyCap | \nIf the line item has a daily budget, this field contains the budget amount | \n
\n\n| maxCap | \nIf the line item has a lifetime budget, this field contains the budget amount | \n
\n\n
\n
Valid token must be passed to use the API
\n","key":"Authorization","type":"text","value":"Bearer "}],"body":{"mode":"graphql","graphql":{"query":"mutation {\n deletePartnerLineItem(lineItemId: \"7948\", clientId: \"\"){\n id\n name\n status\n creativeIds\n bid {\n id\n bidStrategy\n bidMicroValue\n bidFlags\n currency {\n id\n name\n code\n }\n dailyCap\n maxCap\n }\n modifier {\n newsfeed\n fsf\n }\n priority\n campaignId\n startTime\n endTime\n timeCreated\n timeEdited\n timeZone\n }\n}","variables":""}},"url":"https://ads.nextdoor-test.com/graphql/api/v1","description":"Deletes a line item.
\nRequest Arguments
\n\n\n\n| Argument | \nDescription | \n
\n\n\n\n| lineItemId | \nLine Item ID | \n
\n\n| clientId | \nClient ID | \n
\n\n
\n
Response Fields
\n\n\n\n| Field | \nDescription | \n
\n\n\n\n| id | \nLine item ID | \n
\n\n| name | \nLine item name | \n
\n\n| status | \nThe status of the line item (ex. \"Live\", \"Deleted\", \"Paused\") | \n
\n\n| creativeIds | \nIDs of the creatives associated with line item | \n
\n\n| bid | \nThe line item's bid | \n
\n\n| modifier | \nModifiers (adjustments) to the line item bid | \n
\n\n| priority | \nA number from 4-16 representing the line item's priority (the lower the number, the higher the priority) | \n
\n\n| campaignId | \nID of campaign that line item had been associated with | \n
\n\n| startTime | \nDate & time that line item should start serving | \n
\n\n| endTime | \nDate & time that line item should stop serving | \n
\n\n| timeCreated | \nDate & time that line item was created | \n
\n\n| timeEdited | \nDate & time that line item was last updated | \n
\n\n| timeZone | \nTime zone | \n
\n\n
\n
Possible values for status
\n\nDraftLivePausedDeletedPending ApprovalDisapprovedCompletedInactive
\nBid Response Fields
\nThe following are the fields returned in the bid object contained in the response:
\n\n\n\n| Field | \nDescription | \n
\n\n\n\n| bidMicroValue | \nThe bid amount (adjusted based on the bid modifier) divided by 1 million | \n
\n\n| currency | \nThe currency for the line item bid | \n
\n\n| dailyCap | \nIf the line item has a daily budget, this field contains the budget amount | \n
\n\n| maxCap | \nIf the line item has a lifetime budget, this field contains the budget amount | \n
\n\n
\n
Valid token must be passed to use the API
\n","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"mutation {\n addPartnerCreative(creativeInput: {\n name: \"Creative name\",\n creativeTemplateId: \"11832774\",\n creativeJsonScript: {\n Advertiser_Name: \"Advertiser name\",\n Headline: \"Headline\",\n Body_Copy: \"Body copy\",\n Url: \"https://www.google.com\",\n Logo_Image: \"https://images.unsplash.com/photo-1494548162494-384bba4ab999?ixlib=rb-1.2.1&ixid=eyJhcHBfaWQiOjEyMDd9&auto=format&fit=crop&w=1400&q=80\",\n Canvas_Image: \"https://images.unsplash.com/photo-1494548162494-384bba4ab999?ixlib=rb-1.2.1&ixid=eyJhcHBfaWQiOjEyMDd9&auto=format&fit=crop&w=1400&q=80\",\n Offer_Text: \"Offer text\",\n CTA: \"CTA\",\n Price: \"10.99\",\n Old_Price: \"19.99\"\n },\n lineItemId: \"7949\",\n }, clientId: \"\"){\n id\n name\n timeCreated\n timeEdited\n creativeJsonScript\n creativeTemplateId\n }\n}","variables":""}},"url":"https://ads.nextdoor-test.com/graphql/api/v1","description":"Creates a new creative.
\nRequest Arguments
\n\n\n\n| Argument | \nDescription | \n
\n\n\n\n| creativeInput | \nProperties of the creative | \n
\n\n| clientId | \nClient ID | \n
\n\n
\n
\n\n\n| Parameter | \nDescription | \n
\n\n\n\n| name | \nCreative name | \n
\n\n| creativeTemplateId | \nCreative template ID | \n
\n\n| creativeJsonScript | \nJSON containing properties of the creative | \n
\n\n| lineItemId | \nID of line item that creative will be added to | \n
\n\n
\n
Possible Values for creativeTemplateId
\n\n\n\n| Value | \nDescription | \n
\n\n\n\n| 11832774 | \nNewsfeed image ads | \n
\n\n| 11872115 | \nAds in the for sale & free section | \n
\n\n
\n
creativeJsonScript Parameters
\n\n\n\n| Parameter | \nDescription | \nRequired for templates with ID | \nImportant Notes | \n
\n\n\n\n| Advertiser_Name | \nAdvertiser name | \nAll | \n | \n
\n\n| Headline | \nHeadline of creative | \nAll | \n | \n
\n\n| Body_Copy | \nBody text of creative | \n11832774 | \nNot rendered in for sale & free ads | \n
\n\n| Url | \nLanding page url | \nAll | \n | \n
\n\n| Logo_Image | \nUrl of advertiser's logo image | \nAll | \nMust link to a valid image! | \n
\n\n| Canvas_Image | \nUrl | \nAll | \nMust link to a valid image! | \n
\n\n| Offer_Text | \nDescribes a special offer | \n11832774 | \nNot rendered in for sale & free ads | \n
\n\n| CTA | \nCall to action | \n11832774 | \nNot rendered in for sale & free ads | \n
\n\n| Price | \nPrice of advertised item | \nOptional | \nOnly rendered in for sale & free ads | \n
\n\n| Old_Price | \nIf price has been discounted, the original price of advertised item | \nOptional | \nOnly rendered in for sale & free ads | \n
\n\n
\n
Response Fields
\n\n\n\n| Field | \nDescription | \n
\n\n\n\n| id | \nCreative ID | \n
\n\n| name | \nCreative name | \n
\n\n| timeCreated | \nDate & time that creative was created | \n
\n\n| timeEdited | \nDate & time that creative was last updated | \n
\n\n| creativeJsonScript | \nJSON containing properties of the creative | \n
\n\n| creativeTemplateId | \nCreative template ID | \n
\n\n
\n
Valid token must be passed to use the API
\n","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query {\n getPartnerCreative(creativeId: \"9599\", clientId: \"\"){\n id\n name\n timeCreated\n timeEdited\n creativeJsonScript\n creativeTemplateId\n }\n}","variables":""}},"url":"https://ads.nextdoor-test.com/graphql/api/v1","description":"Retrieves a particular creative.
\nRequest Arguments
\n\n\n\n| Argument | \nDescription | \n
\n\n\n\n| creativeId | \nCreative ID | \n
\n\n| clientId | \nClient ID | \n
\n\n
\n
Response Fields
\n\n\n\n| Field | \nDescription | \n
\n\n\n\n| id | \nCreative ID | \n
\n\n| name | \nCreative name | \n
\n\n| timeCreated | \nDate & time that creative was created | \n
\n\n| timeEdited | \nDate & time that creative was last updated | \n
\n\n| creativeJsonScript | \nJSON containing properties of the creative | \n
\n\n| creativeTemplateId | \nCreative template ID | \n
\n\n
\n
Valid token must be passed to use the API
\n","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"mutation {\n updatePartnerCreative(creativeId: \"9598\", creativeInput: {\n name: \"Creative name\",\n creativeJsonScript: {\n Advertiser_Name: \"Advertiser name\",\n Headline: \"Headline\",\n Body_Copy: \"Body copy\",\n Url: \"https://www.google.com\",\n Logo_Image: \"https://images.unsplash.com/photo-1494548162494-384bba4ab999?ixlib=rb-1.2.1&ixid=eyJhcHBfaWQiOjEyMDd9&auto=format&fit=crop&w=1400&q=80\",\n Canvas_Image: \"https://images.unsplash.com/photo-1494548162494-384bba4ab999?ixlib=rb-1.2.1&ixid=eyJhcHBfaWQiOjEyMDd9&auto=format&fit=crop&w=1400&q=80\",\n Offer_Text: \"Offer text\",\n CTA: \"CTA\",\n Price: \"11.99\",\n Old_Price: \"20.99\"\n }\n }, clientId: \"\"){\n\t id\n name\n timeCreated\n timeEdited\n creativeJsonScript\n creativeTemplateId\n }\n}","variables":""}},"url":"https://ads.nextdoor-test.com/graphql/api/v1","description":"Updates a creative.
\nRequest Arguments
\n\n\n\n| Argument | \nDescription | \n
\n\n\n\n| creativeId | \nCreative ID | \n
\n\n| creativeInput | \nProperties of the creative | \n
\n\n| clientId | \nClient ID | \n
\n\n
\n
\n\n\n| Parameter | \nDescription | \nRequired | \n
\n\n\n\n| name | \nCreative name | \nOptional | \n
\n\n| creativeJsonScript | \nJSON containing properties of the creative | \nOptional | \n
\n\n
\n
creativeJsonScript Parameters
\nNOTE: To update a specific parameter in the creativeJsonScript, all the required parameters must still be passed.
\nEx. Even if you'd only like to update the Advertiser_Name in the creativeJsonScript, you must still pass all the other required parameters. You will receive an error if you pass a creativeJsonScript with only the Advertiser_Name property.
\n\n\n\n| Parameter | \nDescription | \nRequired for templates with ID | \nImportant Notes | \n
\n\n\n\n| Advertiser_Name | \nAdvertiser name | \nAll | \n | \n
\n\n| Headline | \nHeadline of creative | \nAll | \n | \n
\n\n| Body_Copy | \nBody text of creative | \n11832774 | \nNot rendered in for sale & free ads | \n
\n\n| Url | \nLanding page url | \nAll | \n | \n
\n\n| Logo_Image | \nUrl of advertiser's logo image | \nAll | \nMust link to a valid image! | \n
\n\n| Canvas_Image | \nUrl | \nAll | \nMust link to a valid image! | \n
\n\n| Offer_Text | \nDescribes a special offer | \n11832774 | \nNot rendered in for sale & free ads | \n
\n\n| CTA | \nCall to action | \n11832774 | \nNot rendered in for sale & free ads | \n
\n\n| Price | \nPrice of advertised item | \nOptional | \nOnly rendered in for sale & free ads | \n
\n\n| Old_Price | \nIf price has been discounted, the original price of advertised item | \nOptional | \nOnly rendered in for sale & free ads | \n
\n\n
\n
Response Fields
\n\n\n\n| Field | \nDescription | \n
\n\n\n\n| id | \nCreative ID | \n
\n\n| name | \nCreative name | \n
\n\n| timeCreated | \nDate & time that creative was created | \n
\n\n| timeEdited | \nDate & time that creative was last updated | \n
\n\n| creativeJsonScript | \nJSON containing properties of the creative | \n
\n\n| creativeTemplateId | \nCreative template ID | \n
\n\n
\n
Valid token must be passed to use the API
\n","key":"Authorization","type":"text","value":"Bearer "}],"body":{"mode":"graphql","graphql":{"query":"mutation {\n deactivatePartnerCreative(creativeId: \"9598\", clientId: \"\"){\n id\n name\n timeCreated\n timeEdited\n creativeJsonScript\n creativeTemplateId\n }\n}","variables":""}},"url":"https://ads.nextdoor-test.com/graphql/api/v1","description":"Deactivates a particular creative.
\nNOTE: This does not delete a creative. The API does not support deleting creatives.
\nRequest Arguments
\n\n\n\n| Argument | \nDescription | \n
\n\n\n\n| creativeId | \nCreative ID | \n
\n\n| clientId | \nClient ID | \n
\n\n
\n
Response Fields
\n\n\n\n| Field | \nDescription | \n
\n\n\n\n| id | \nCreative ID | \n
\n\n| name | \nCreative name | \n
\n\n| timeCreated | \nDate & time that creative was created | \n
\n\n| timeEdited | \nDate & time that creative was last updated | \n
\n\n| creativeJsonScript | \nJSON containing properties of the creative | \n
\n\n| creativeTemplateId | \nCreative template ID | \n
\n\n
\n
Valid token must be passed to use the API
\n","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query {\n getPartnerCampaignReport(\n clientId: \"\", \n filters: {\n startDate: \"2018-09-23 22:36:50\",\n endDate: \"2021-09-23 22:36:50\",\n name: \"Campaign name\"\n }\n ) {\n campaignId,\n clientName,\n campaignName,\n status,\n impressions,\n clicks,\n ctr,\n spend,\n conversions\n }\n}","variables":""}},"url":"https://ads.nextdoor-test.com/graphql/api/v1","description":"Retrieves a report of ad campaigns.
\nRequest Arguments
\n\n\n\n| Argument | \nDescription | \nRequired | \n
\n\n\n\n| clientId | \nClient ID | \nR | \n
\n\n| filters | \nFilters applied to the report results | \nR | \n
\n\n
\n
Filters
\n\n\n\n| Filter | \nDescription | \nRequired | \n
\n\n\n\n| startDate | \nAll campaigns returned in the report will have a startDate greater than or equal to this filter | \nR | \n
\n\n| endDate | \nAll campaigns returned in the report will have an endDate less than or equal to this filter | \nR | \n
\n\n| name | \nAll campaigns returned in the report will have the name specified in this filter | \nO | \n
\n\n
\n
Response Fields
\n\n\n\n| Field | \nDescription | \n
\n\n\n\n| campaignId | \nCampaign ID | \n
\n\n| clientName | \nName of client who created the campaign | \n
\n\n| campaignName | \nCampaign name | \n
\n\n| status | \nThe status of the campaign (ex. \"Live\", \"Deleted\", \"Paused\") | \n
\n\n| impressions | \nNumber of impressions | \n
\n\n| clicks | \nNumber of clicks | \n
\n\n| ctr | \nClick-through rate | \n
\n\n| spend | \nAmount spent for the campaign | \n
\n\n| conversion | \nNumber of conversions | \n
\n\n
\n
Possible values for status
\n\nDraftLivePausedDeletedPending ApprovalDisapprovedCompletedInactive
\n","urlObject":{"protocol":"https","path":["graphql","api","v1"],"host":["ads","nextdoor-test","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"da4d0a93-4a31-4108-bff1-ac4384466e95"},{"name":"getPartnerLineItemReport","id":"84cf755a-07df-472c-b057-4ba719c03122","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","description":"Valid token must be passed to use the API
\n","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query {\n getPartnerLineItemReport(\n clientId: \"\", \n filters: {\n startDate: \"2018-09-23 22:36:50\",\n endDate: \"2021-09-23 22:36:50\",\n name: \"Line item name\"\n }\n ) {\n campaignId,\n lineItemId,\n creativeTemplateId,\n clientName,\n lineItemName,\n status,\n impressions,\n clicks,\n ctr,\n spend,\n conversions\n }\n}","variables":""}},"url":"https://ads.nextdoor-test.com/graphql/api/v1","description":"Retrieves a report of line items.
\nRequest Arguments
\n\n\n\n| Argument | \nDescription | \nRequired | \n
\n\n\n\n| clientId | \nClient ID | \nR | \n
\n\n| filters | \nFilters applied to the report results | \nR | \n
\n\n
\n
Filters
\n\n\n\n| Filter | \nDescription | \nRequired | \n
\n\n\n\n| startDate | \nAll line items returned in the report will have a startDate greater than or equal to this filter | \nR | \n
\n\n| endDate | \nAll line items returned in the report will have an endDate less than or equal to this filter | \nR | \n
\n\n| name | \nAll line items returned in the report will have the name specified in this filter | \nO | \n
\n\n
\n
Response Fields
\n\n\n\n| Field | \nDescription | \n
\n\n\n\n| campaignId | \nID of campaign that line item is associated with | \n
\n\n| lineItemId | \nLine item ID | \n
\n\n| creativeTemplateId | \nThe creative template ID that all creatives in the line item are expected to have | \n
\n\n| clientName | \nName of client who created the campaign | \n
\n\n| lineItemName | \nLine item name | \n
\n\n| status | \nThe status of the line item (ex. \"Live\", \"Deleted\", \"Paused\") | \n
\n\n| impressions | \nNumber of impressions | \n
\n\n| clicks | \nNumber of clicks | \n
\n\n| ctr | \nClick-through rate | \n
\n\n| spend | \nAmount spent for the line item | \n
\n\n| conversion | \nNumber of conversions | \n
\n\n
\n
Possible values for status
\n\nDraftLivePausedDeletedPending ApprovalDisapprovedCompletedInactive
\n","urlObject":{"protocol":"https","path":["graphql","api","v1"],"host":["ads","nextdoor-test","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"84cf755a-07df-472c-b057-4ba719c03122"},{"name":"getPartnerCreativeReport","id":"6b9246b2-b54e-4cd7-ae2a-c38938601951","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","description":"Valid token must be passed to use the API
\n","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query {\n getPartnerCreativeReport(\n clientId: \"\", \n filters: {\n startDate: \"2018-09-23 22:36:50\",\n endDate: \"2021-09-23 22:36:50\",\n name: \"Creative name\"\n }\n ) {\n campaignId,\n lineItemId,\n creativeId,\n creativeTemplateId,\n clientName,\n creativeName,\n status,\n impressions,\n clicks,\n ctr,\n spend,\n conversions\n }\n}","variables":""}},"url":"https://ads.nextdoor-test.com/graphql/api/v1","description":"Retrieves a report of creatives.
\nRequest Arguments
\n\n\n\n| Argument | \nDescription | \nRequired | \n
\n\n\n\n| clientId | \nClient ID | \nR | \n
\n\n| filters | \nFilters applied to the report results | \nR | \n
\n\n
\n
Filters
\n\n\n\n| Filter | \nDescription | \nRequired | \n
\n\n\n\n| startDate | \nAll creatives returned in the report will have a startDate greater than or equal to this filter | \nR | \n
\n\n| endDate | \nAll creatives returned in the report will have an endDate less than or equal to this filter | \nR | \n
\n\n| name | \nAll creatives returned in the report will have the name specified in this filter | \nO | \n
\n\n
\n
Response Fields
\n\n\n\n| Field | \nDescription | \n
\n\n\n\n| campaignId | \nID of campaign that creative is associated with | \n
\n\n| lineItemId | \nID of line item that creative is associated with | \n
\n\n| creativeId | \nCreative ID | \n
\n\n| creativeTemplateId | \nThe creative's template ID | \n
\n\n| clientName | \nName of client who created the campaign | \n
\n\n| creativeName | \nCreative name | \n
\n\n| status | \nThe status of the creative | \n
\n\n| impressions | \nNumber of impressions | \n
\n\n| clicks | \nNumber of clicks | \n
\n\n| ctr | \nClick-through rate | \n
\n\n| spend | \nAmount spent for the creative | \n
\n\n| conversion | \nNumber of conversions | \n
\n\n
\n
Possible values for status
\n\nDraftLivePausedDeletedPending ApprovalDisapprovedCompletedInactive
\n","urlObject":{"protocol":"https","path":["graphql","api","v1"],"host":["ads","nextdoor-test","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"6b9246b2-b54e-4cd7-ae2a-c38938601951"},{"name":"getAllPartnerCampaigns","id":"be1ca992-8cc9-452d-81be-53295a032534","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text","description":"Valid token must be passed to use the API
\n"}],"body":{"mode":"graphql","graphql":{"query":"query {\n getAllPartnerCampaigns(clientId: \"\") {\n id\n name\n objective\n status\n }\n}","variables":""}},"url":"https://ads.nextdoor-test.com/graphql/api/v1","description":"Returns a list of all the campaigns for a particular client.
\nRequest Arguments
\n\n\n\n| Argument | \nDescription | \n
\n\n\n\n| clientId | \nClient ID | \n
\n\n
\n
Response Fields
\n\n\n\n| Field | \nDescription | \n
\n\n\n\n| id | \nCampaign ID | \n
\n\n| name | \nCampaign name | \n
\n\n| objective | \nThe objective of the campaign (ex. build awareness, get conversion, etc.) | \n
\n\n| status | \nThe status of the campaign (ex. \"Live\", \"Deleted\", \"Paused\") | \n
\n\n
\n
Possible values for campaign objective
\n\n\n\n| Value | \nDescription | \n
\n\n\n\n| 1 | \nBuild awareness | \n
\n\n| 2 | \nDrive consideration | \n
\n\n| 3 | \nGet conversion | \n
\n\n
\n
Possible values for status
\n\nDraftLivePausedDeletedPending ApprovalDisapprovedCompletedInactive
\n","urlObject":{"protocol":"https","path":["graphql","api","v1"],"host":["ads","nextdoor-test","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"be1ca992-8cc9-452d-81be-53295a032534"},{"name":"getAllPartnerLineItems","id":"9d87ecd4-4ff3-4bdd-a14f-89684f891551","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","description":"Valid token must be passed to use the API
\n","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query {\n getAllPartnerLineItems(clientId: \"\") {\n id\n name\n status\n creativeIds\n bid {\n bidStrategy\n bidMicroValue\n currency {\n name\n code\n }\n dailyCap\n maxCap\n }\n modifier {\n newsfeed\n fsf\n }\n priority\n campaignId\n startTime\n endTime\n timeCreated\n timeEdited\n timeZone\n }\n}","variables":""}},"url":"https://ads.nextdoor-test.com/graphql/api/v1","description":"Returns a list of all the active line items for a particular client.
\nRequest Arguments
\n\n\n\n| Argument | \nDescription | \n
\n\n\n\n| clientId | \nClient ID | \n
\n\n
\n
Response Fields
\n\n\n\n| Field | \nDescription | \n
\n\n\n\n| id | \nLine item ID | \n
\n\n| name | \nLine item name | \n
\n\n| status | \nThe status of the line item (ex. \"Live\", \"Deleted\", \"Paused\") | \n
\n\n| creativeIds | \nIDs of the creatives associated with line item | \n
\n\n| bid | \nThe line item's bid | \n
\n\n| modifier | \nModifiers (adjustments) to the line item bid | \n
\n\n| priority | \nA number from 4-16 representing the line item's priority (the lower the number, the higher the priority) | \n
\n\n| campaignId | \nID of campaign that line item is associated with | \n
\n\n| startTime | \nDate & time that line item should start serving | \n
\n\n| endTime | \nDate & time that line item should stop serving | \n
\n\n| timeCreated | \nDate & time that line item was created | \n
\n\n| timeEdited | \nDate & time that line item was last updated | \n
\n\n| timeZone | \nTime zone | \n
\n\n
\n
Possible values for status
\n\nDraftLivePausedDeletedPending ApprovalDisapprovedCompletedInactive
\nBid Response Fields
\nThe following are the fields returned in the bid object contained in the response:
\n\n\n\n| Field | \nDescription | \n
\n\n\n\n| bidMicroValue | \nThe bid amount (adjusted based on the bid modifier) divided by 1 million | \n
\n\n| currency | \nThe currency for the line item bid | \n
\n\n| dailyCap | \nIf the line item has a daily budget, this field contains the budget amount | \n
\n\n| maxCap | \nIf the line item has a lifetime budget, this field contains the budget amount | \n
\n\n
\n
Valid token must be passed to use the API
\n"}],"body":{"mode":"graphql","graphql":{"query":"query {\n getAllPartnerCreatives(clientId: \"\") {\n id\n name\n timeCreated\n timeEdited\n creativeJsonScript\n creativeTemplateId\n }\n}","variables":""}},"url":"https://ads.nextdoor-test.com/graphql/api/v1","description":"Returns a list of all the creatives for a particular client.
\nRequest Arguments
\n\n\n\n| Argument | \nDescription | \n
\n\n\n\n| clientId | \nClient ID | \n
\n\n
\n
Response Fields
\n\n\n\n| Field | \nDescription | \n
\n\n\n\n| id | \nCreative ID | \n
\n\n| name | \nCreative name | \n
\n\n| timeCreated | \nDate & time that creative was created | \n
\n\n| timeEdited | \nDate & time that creative was last updated | \n
\n\n| creativeJsonScript | \nJSON containing properties of the creative | \n
\n\n| creativeTemplateId | \nCreative template ID | \n
\n\n
\n
Valid token must be passed to use the API
\n","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query {\n getAccount {\n id\n userName\n firstName\n lastName\n email\n status\n userDetails\n clientName\n }\n}","variables":""}},"url":"https://ads.nextdoor-test.com/graphql/api/v1","description":"Returns basic information on the Nextdoor Ads user account that's currently logged in.
\nResponse Fields
\n\n\n\n| Field | \nDescription | \n
\n\n\n\n| id | \nUser ID | \n
\n\n| userName | \nUsername | \n
\n\n| firstName | \nUser's first name | \n
\n\n| lastName | \nUser's last name | \n
\n\n| email | \nUser's email address | \n
\n\n| status | \nThe status of the user account | \n
\n\n| userDetails | \nJSON string containing the user's business name and industry | \n
\n\n| clientName | \nName of advertiser/client associated with user account | \n
\n\n
\n
Possible values for status
\n\nLiveDeletedPending Approval
\n","urlObject":{"protocol":"https","path":["graphql","api","v1"],"host":["ads","nextdoor-test","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"580460e0-4932-459d-bd63-83134ede75a1"}]}