Other/API Reference - Ideal Postcodes

Usage Stats

v1.0.0

Reports the number of lookups consumed on a key for a range of days.

A maximum interval of 90 days can be provided for analysis. If no start or end date is provided, the last 21 days will be used as the default interval.

Input

{
  "type": "object",
  "properties": {
    "end": {
      "type": "integer",
      "format": "int32",
      "description": "An start date/time in the form of a UNIX Timestamp in milliseconds, e.g.  `1418556477882`.\n"
    },
    "key": {
      "type": "string",
      "description": "Your API Key. Typically beings `ak_`.\n\nAvailable from your dashboard\n"
    },
    "licensee": {
      "type": "string",
      "description": "Uniquely identifies a licensee\n"
    },
    "start": {
      "type": "integer",
      "format": "int32",
      "description": "A start date/time in the form of a UNIX Timestamp in milliseconds, e.g.  `1418556452651`.\n"
    },
    "tags": {
      "type": "string",
      "description": "A comma separated list of tags to query over. \n\nUseful if you want to specify the circumstances in which the request was made.\n\nIf multiple tags are specified, the response will only comprise of requests for which all the tags are satisfied - i.e. searching `\"foo,bar\"` will only query requests which tagged both `\"foo\"` and `\"bar\"`.\n"
    }
  },
  "required": [
    "key"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "required": [
    "code",
    "message",
    "result"
  ],
  "properties": {
    "code": {
      "type": "integer",
      "format": "int32",
      "enum": [
        2000
      ]
    },
    "message": {
      "type": "string",
      "enum": [
        "Success"
      ]
    },
    "result": {
      "type": "object",
      "required": [
        "dailyCount",
        "end",
        "start",
        "total"
      ],
      "properties": {
        "dailyCount": {
          "type": "array",
          "description": "An array of objects representing number of paid lookups made on specific days, ordered by date. Each object contains a `date` attribute, which represents the day and a `count` attribute, which represents the number of paid lookups made on that day.\n",
          "items": {
            "type": "object",
            "required": [
              "date",
              "count"
            ],
            "properties": {
              "count": {
                "type": "integer",
                "format": "int32"
              },
              "date": {
                "type": "string"
              }
            }
          }
        },
        "end": {
          "type": "string",
          "description": "End date in ISO 8601 format."
        },
        "start": {
          "type": "string",
          "description": "Start date in ISO 8601 format."
        },
        "total": {
          "type": "integer",
          "format": "int32",
          "description": "Total of paid lookups performed in specified period."
        }
      }
    }
  }
}