Cardlytics

Cardlytics Geo API

The Geo API from Cardlytics — 6 operation(s) for geo.

GitHub OpenAPI

Operations 7

GET /v6/Geo Returns Geo results that match the query #
POST /v6/Geo Returns Bulk Geo results based on the body criteria #
GET /v6/Geo/Country Returns Geo Country results that match the query #
GET /v6/Geo/DMA Returns Geo DMA results that match the query #
GET /v6/Geo/Locality Returns Geo Locality results that match the query #
GET /v6/Geo/PostalCode Returns Geo PostalCode results that match the query #
GET /v6/Geo/Region Returns Geo Region results that match the query #

Documentation

📖
Documentation
https://platform.cardlytics.com/advertisers/docs/api-get-started
📖
APIReference
https://platform.cardlytics.com/advertisers/reference
📖
GettingStarted
https://platform.cardlytics.com/advertisers/docs/api-get-started
📖
Documentation
https://platform.cardlytics.com/advertisers
📖
Documentation
https://platform.cardlytics.com/publisher-integrations
📖
APIReference
https://platform.cardlytics.com/publisher-integrations/reference
📖
GettingStarted
https://docs.cardlytics.com/ads/v2/getting-started/get-started.html

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/cardlytics/refs/heads/main/openapi/cardlytics-geo-api-openapi.yml

Other Resources

🔗
Sandbox
https://api-sandbox.cardlytics.com
🔗
ChangeLog
https://platform.cardlytics.com/advertisers/changelog
🔗
Sandbox
https://pub-api-us.sandbox.cardlytics.com
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/cardlytics/refs/heads/main/asyncapi/cardlytics-publisher-webhooks.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/cardlytics-geo-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

cardlytics-geo-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Campaign Build Geo API
  version: latest
security:
- oauth2-cognito:
  - read
tags:
- name: Geo
paths:
  /v6/Geo:
    get:
      tags:
      - Geo
      summary: Returns Geo results that match the query
      parameters:
      - name: query
        in: query
        description: Query to search in Geo.
        schema:
          type: string
      - name: countryId
        in: query
        description: Required CountryId filter.
        schema:
          type: integer
          format: int32
      - name: PerPage
        in: query
        schema:
          minimum: 1
          type: integer
          format: int32
      - name: Page
        in: query
        schema:
          minimum: 1
          type: integer
          format: int32
      responses:
        '200':
          description: The geo results found and returned in the response body.
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/GeoSearchResourceModel'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/GeoSearchResourceModel'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/GeoSearchResourceModel'
      operationId: getV6Geo
      x-operation-id-source: derived
    post:
      tags:
      - Geo
      summary: Returns Bulk Geo results based on the body criteria
      requestBody:
        description: Request body containing list(s) of geo criteria to query for results.
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/PostGeoBulkSearchResourceModel'
          application/json:
            schema:
              $ref: '#/components/schemas/PostGeoBulkSearchResourceModel'
          text/json:
            schema:
              $ref: '#/components/schemas/PostGeoBulkSearchResourceModel'
          application/*+json:
            schema:
              $ref: '#/components/schemas/PostGeoBulkSearchResourceModel'
      responses:
        '200':
          description: The bulk Geo results found and returned in the response body.
          content:
            text/plain:
              schema:
                type: object
                additionalProperties:
                  $ref: '#/components/schemas/MatchedGeoSearchResourceModel'
            application/json:
              schema:
                type: object
                additionalProperties:
                  $ref: '#/components/schemas/MatchedGeoSearchResourceModel'
            text/json:
              schema:
                type: object
                additionalProperties:
                  $ref: '#/components/schemas/MatchedGeoSearchResourceModel'
      operationId: postV6Geo
      x-operation-id-source: derived
  /v6/Geo/Country:
    get:
      tags:
      - Geo
      summary: Returns Geo Country results that match the query
      parameters:
      - name: query
        in: query
        description: Query to search in geo. Country filters specified with two letters are applied to the Abbreviation field, natural language queries are applied to the Description.
        schema:
          type: string
        example: GB
      - name: PerPage
        in: query
        schema:
          minimum: 1
          type: integer
          format: int32
      - name: Page
        in: query
        schema:
          minimum: 1
          type: integer
          format: int32
      responses:
        '200':
          description: The geo.Country results found and returned in the response body.
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/GeoSearchResourceModel'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/GeoSearchResourceModel'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/GeoSearchResourceModel'
      operationId: getV6GeoCountry
      x-operation-id-source: derived
  /v6/Geo/DMA:
    get:
      tags:
      - Geo
      summary: Returns Geo DMA results that match the query
      parameters:
      - name: query
        in: query
        description: Query to search in geo.DMA.
        schema:
          type: string
      - name: countryId
        in: query
        description: Required CountryId filter.
        schema:
          type: integer
          format: int32
      - name: PerPage
        in: query
        schema:
          minimum: 1
          type: integer
          format: int32
      - name: Page
        in: query
        schema:
          minimum: 1
          type: integer
          format: int32
      responses:
        '200':
          description: The geo.Dma results found and returned in the response body.
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/GeoSearchResourceModel'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/GeoSearchResourceModel'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/GeoSearchResourceModel'
      operationId: getV6GeoDMA
      x-operation-id-source: derived
  /v6/Geo/Locality:
    get:
      tags:
      - Geo
      summary: Returns Geo Locality results that match the query
      parameters:
      - name: query
        in: query
        description: Query to search in geo.Locality.
        schema:
          type: string
      - name: countryId
        in: query
        description: Required CountryId filter.
        schema:
          type: integer
          format: int32
      - name: PerPage
        in: query
        schema:
          minimum: 1
          type: integer
          format: int32
      - name: Page
        in: query
        schema:
          minimum: 1
          type: integer
          format: int32
      responses:
        '200':
          description: The geo.Locality results found and returned in the response body.
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/GeoSearchResourceModel'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/GeoSearchResourceModel'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/GeoSearchResourceModel'
      operationId: getV6GeoLocality
      x-operation-id-source: derived
  /v6/Geo/PostalCode:
    get:
      tags:
      - Geo
      summary: Returns Geo PostalCode results that match the query
      parameters:
      - name: query
        in: query
        description: Query to search in geo.PostalCode.
        schema:
          type: string
      - name: countryId
        in: query
        description: Required CountryId filter.
        schema:
          type: integer
          format: int32
      - name: PerPage
        in: query
        schema:
          minimum: 1
          type: integer
          format: int32
      - name: Page
        in: query
        schema:
          minimum: 1
          type: integer
          format: int32
      responses:
        '200':
          description: The geo.PostalCode results found and returned in the response body.
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/GeoSearchResourceModel'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/GeoSearchResourceModel'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/GeoSearchResourceModel'
      operationId: getV6GeoPostalCode
      x-operation-id-source: derived
  /v6/Geo/Region:
    get:
      tags:
      - Geo
      summary: Returns Geo Region results that match the query
      parameters:
      - name: query
        in: query
        description: Query to search in geo.Region.
        schema:
          type: string
      - name: countryId
        in: query
        description: Required CountryId filter.
        schema:
          type: integer
          format: int32
      - name: PerPage
        in: query
        schema:
          minimum: 1
          type: integer
          format: int32
      - name: Page
        in: query
        schema:
          minimum: 1
          type: integer
          format: int32
      responses:
        '200':
          description: The geo.Region results found and returned in the response body.
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/GeoSearchResourceModel'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/GeoSearchResourceModel'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/GeoSearchResourceModel'
      operationId: getV6GeoRegion
      x-operation-id-source: derived
components:
  schemas:
    GeoType:
      enum:
      - COUNTRY
      - REGION
      - LOCALITY
      - DMA
      - POSTAL_CODE
      type: string
    PostGeoBulkSearchResourceModel:
      type: object
      properties:
        subLevelCountryId:
          type: integer
          format: int32
        country:
          type:
          - array
          - 'null'
          items:
            type: string
          description: Country filters specified with two letters are applied to the Abbreviation field, natural language queries are applied to the Description.
        dma:
          type:
          - array
          - 'null'
          items:
            type: string
        region:
          type:
          - array
          - 'null'
          items:
            type: string
        locality:
          type:
          - array
          - 'null'
          items:
            type: string
        postalCode:
          type:
          - array
          - 'null'
          items:
            type: string
      additionalProperties: false
    GeoSearchResourceModel:
      type: object
      properties:
        name:
          type:
          - string
          - 'null'
          description: Geo search result Name.
        description:
          type:
          - string
          - 'null'
          description: Geo search result Full Description.
        code:
          type:
          - string
          - 'null'
          description: Geo search result code.
        abbreviation:
          type:
          - string
          - 'null'
          description: Geo search result abbreviation.
        id:
          type: integer
          description: Geo search result unique reference Id for the given GeoType.
          format: int32
        countryId:
          type: integer
          description: The country id associated with this Geo search result.
          format: int32
        geoType:
          $ref: '#/components/schemas/GeoType'
      additionalProperties: false
      description: Model Class the represents a Geo Search result.
    MatchedGeoSearchResourceModel:
      type: object
      properties:
        matched:
          type: integer
          format: int32
          readOnly: true
        matches:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/GeoSearchResourceModel'
      additionalProperties: false
  securitySchemes:
    oauth2-cognito:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://advertiser-auth-preprod.auth.us-east-1.amazoncognito.com/oauth2/authorize
          tokenUrl: https://advertiser-auth-preprod.auth.us-east-1.amazoncognito.com/oauth2/token
          scopes:
            openid: openid
      x-tokenName: id_token