SparkAds

Get this advertiser's own ad performance for the last 30 days: impressions and clicks split by day, by app in the Spark network, and by traffic source, plus every creative they own with its review status. Read-only. Scoped to the API key holder; it cannot report on anyone else.

{
  "type": "object",
  "properties": {},
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Get the hour this advertiser holds: the UTC hour, the same hour on their target country's clock, the country itself, and the card that runs in it with its review status. Also reports whether the ad is actually live right now, which needs all three of a held hour, an approved card and a paying subscription. Read-only.

{
  "type": "object",
  "properties": {},
  "$schema": "http://json-schema.org/draft-07/schema#"
}

List the UTC hours nobody has claimed yet, out of the 24 the network sells. Pass a country to also get each free hour on that country's clock and the best five ranked by local evening attention. Supported countries: GB, IE, PT, FR, DE, ES, IT, NL, BE, SE, NO, DK, PL, CH, AT, NG, FI, GR, RO, UA, EG, ZA, IL, SA, TR, RU, KE, AE, PK, IN, BD, TH, VN, ID, CN, SG, MY, PH, HK, TW, AU, JP, KR, NZ, BR, AR, US, CA, PE, CO, MX. Read-only; claiming an hour still happens on the website.

{
  "type": "object",
  "properties": {
    "country": {
      "description": "ISO-3166 alpha-2 country code, e.g. GB or US. Adds local times and peak suggestions.",
      "type": "string",
      "minLength": 2,
      "maxLength": 2
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Get the whole network's last 24 hours: total impressions, total clicks, how many apps showed the carousel, and how many of the 24 hourly slots are taken. This is the public inventory figure, the same one the SparkAds landing page prints, not this advertiser's own numbers. Read-only.

{
  "type": "object",
  "properties": {},
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Edit this advertiser's ad card. Pass only the fields to change; anything omitted keeps its current value. WRITE TOOL, and it costs something: saving resets the card's status to 'pending', so the ad STOPS running until a person approves it again. Say that to the user and get their agreement before calling this. Caps: name 40 characters, tagline 60, one-sentence body 160, url must be https, domain must be a bare hostname like myapp.com. House style: plain words, no exclamation marks, and the sentence says what the product does rather than why it is good.

{
  "type": "object",
  "properties": {
    "name": {
      "description": "The app name shown on the card.",
      "type": "string",
      "maxLength": 40
    },
    "url": {
      "description": "Where the card links to. Must be https.",
      "type": "string",
      "maxLength": 200
    },
    "domain": {
      "description": "Bare hostname, e.g. myapp.com. The card takes its logo and colour from here.",
      "type": "string",
      "maxLength": 100
    },
    "tagline": {
      "description": "Four or five words, sits under the name.",
      "type": "string",
      "maxLength": 60
    },
    "body": {
      "description": "One sentence saying what the product does.",
      "type": "string",
      "maxLength": 160
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#"
}