analytics

Embed

<a href="https://hermeticor.com/docs/ref-analytics"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/83d044a8-2e41-46eb-a741-5043d696d3f3/social-card.svg?v=3e7ae33eec8b" alt="analytics" width="600" height="315"></a>

GEThttps://hermeticor.com/v1/geo-ips/{ip}

One shortened network address (the id is the shortened address itself)

Parameters

ipstringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/geo-ips/{ip}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "ip": "string",
  "country": "string",
  "events": 0,
  "people": 0,
  "lastSeenAt": "2024-01-01T00:00:00Z"
}

Schema

ipstringrequired

countrystringrequired

eventsnumberrequired

peoplenumberrequired

lastSeenAtstringrequired

4XX Default Response

Example

{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}

Schema

errorobjectrequired

Show child parameters

codestringrequired

messagestringrequired

detailsobject

5XX Default Response

Same as 4XX · GET /v1/geo-ips/{ip}

GEThttps://hermeticor.com/v1/geo-ips/{ip}/address

Where a shortened address is: the country from the edge header (no street or city is ever kept)

Parameters

ipstringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/geo-ips/{ip}/address" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "ip": "string",
  "country": "string"
}

Schema

ipstringrequired

countrystringrequired

4XX Default Response

Same as 4XX · GET /v1/geo-ips/{ip}

5XX Default Response

Same as 4XX · GET /v1/geo-ips/{ip}

GEThttps://hermeticor.com/v1/geo-addresses/{key}

One place group; the key is country|region|city (empty parts allowed)

Parameters

keystringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/geo-addresses/{key}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "country": "string",
  "region": "string",
  "city": "string",
  "contacts": 0
}

Schema

countrystringrequired

regionstringrequired

citystringrequired

contactsnumberrequired

4XX Default Response

Same as 4XX · GET /v1/geo-ips/{ip}

5XX Default Response

Same as 4XX · GET /v1/geo-ips/{ip}

GEThttps://hermeticor.com/v1/geo-addresses

Country, region and city groups with contact counts

Parameters

limitintegerquery

= 100

countrystringquery

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/geo-addresses" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "country": "string",
      "region": "string",
      "city": "string",
      "contacts": 0
    }
  ]
}

Schema

itemsGetV1GeoAddressesByKeyResponse[]required

Show child parameters

countrystringrequired

regionstringrequired

citystringrequired

contactsnumberrequired

4XX Default Response

Same as 4XX · GET /v1/geo-ips/{ip}

5XX Default Response

Same as 4XX · GET /v1/geo-ips/{ip}

GEThttps://hermeticor.com/v1/benchmarks/settings

Peer benchmark sharing: opt-in state, peer profile and the consent text

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/benchmarks/settings" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "optedIn": true,
  "industry": "string",
  "region": "string",
  "sizeBand": "string",
  "revenueBand": "string",
  "aovBand": "string",
  "consent": {
    "version": "string",
    "text": "string",
    "acceptedAt": "2024-01-01T00:00:00Z"
  },
  "hub": {
    "configured": true,
    "lastStatus": "string",
    "lastSubmittedAt": "2024-01-01T00:00:00Z",
    "deletionPending": true
  },
  "industries": [
    {
      "key": "string",
      "label": "string"
    }
  ],
  "regions": [
    {
      "key": "string",
      "label": "string"
    }
  ],
  "sizes": [
    {
      "key": "string",
      "label": "string"
    }
  ]
}

Schema

optedInbooleanrequired

industrystringrequired

regionstringrequired

sizeBandstringrequired

revenueBandstringrequired

aovBandstringrequired

consentobjectrequired

Show child parameters

versionstringrequired

textstringrequired

acceptedAtstringrequired

hubobjectrequired

Show child parameters

configuredbooleanrequired

lastStatusstringrequired

lastSubmittedAtstringrequired

deletionPendingbooleanrequired

industriesobject[]required

Show child parameters

keystringrequired

labelstringrequired

regionsobject[]required

Show child parameters

keystringrequired

labelstringrequired

sizesobject[]required

Show child parameters

keystringrequired

labelstringrequired

4XX Default Response

Same as 4XX · GET /v1/geo-ips/{ip}

5XX Default Response

Same as 4XX · GET /v1/geo-ips/{ip}

PUThttps://hermeticor.com/v1/benchmarks/settings

Turn peer benchmark sharing on (explicit consent required) or off (deletes your contribution)

Request body

application/json

optedInbooleanrequired

industrystring

regionstring

consentVersionstring

{
  "optedIn": true,
  "industry": "string",
  "region": "string",
  "consentVersion": "string"
}

Code samples

cURL

curl -X PUT "https://hermeticor.com/v1/benchmarks/settings" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"optedIn":true,"industry":"string","region":"string","consentVersion":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · GET /v1/benchmarks/settings

4XX Default Response

Same as 4XX · GET /v1/geo-ips/{ip}

5XX Default Response

Same as 4XX · GET /v1/geo-ips/{ip}

GEThttps://hermeticor.com/v1/benchmarks

Peer benchmarks (overview): your last 90 days against peer percentiles, falling back to a labelled static reference table

Parameters

industrystringquery

sizestringquery

regionstringquery

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/benchmarks" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "section": "overview",
  "optedIn": true,
  "days": 0,
  "currency": "string",
  "requested": {
    "industry": "string",
    "size": "string",
    "region": "string"
  },
  "metrics": [
    {
      "key": "string",
      "unit": "rate",
      "lowerIsBetter": true,
      "yours": 0,
      "source": "network",
      "peers": {
        "p10": 0,
        "p25": 0,
        "p50": 0,
        "p75": 0,
        "p90": 0,
        "mean": 0
      },
      "rank": 0,
      "status": "poor",
      "peerGroup": {
        "cohort": "string",
        "contributors": 0,
        "rolledUp": [
          "string"
        ]
      },
      "fx": {
        "currency": "string",
        "rateDate": "string"
      },
      "reference": {
        "low": 0,
        "high": 0,
        "verdict": "below"
      }
    }
  ],
  "summary": {
    "poor": 0,
    "fair": 0,
    "good": 0,
    "excellent": 0,
    "unranked": 0
  },
  "notice": "string",
  "staticDataset": {
    "version": "string",
    "note": "string"
  }
}

Schema

sectionstringrequired

overview | campaigns | flows | forms | sms

optedInbooleanrequired

daysintegerrequired

currencystringrequired

requestedobjectrequired

Show child parameters

industrystringrequired

sizestringrequired

regionstringrequired

metricsMetricsItem[]required

Show child parameters

keystringrequired

unitstringrequired

rate | money

lowerIsBetterbooleanrequired

yoursnumberrequired

sourcestringrequired

network | local_peers | static_reference

peersobjectrequired

Show child parameters

p10numberrequired

p25numberrequired

p50numberrequired

p75numberrequired

p90numberrequired

meannumberrequired

rankintegerrequired

statusstringrequired

poor | fair | good | excellent

peerGroupobjectrequired

Show child parameters

cohortstringrequired

contributorsintegerrequired

rolledUpstring[]required

fxobject

Show child parameters

currencystringrequired

rateDatestringrequired

referenceobjectrequired

Show child parameters

lownumberrequired

highnumberrequired

verdictstringrequired

below | within | above

summaryobjectrequired

Show child parameters

poorintegerrequired

fairintegerrequired

goodintegerrequired

excellentintegerrequired

unrankedintegerrequired

noticestringrequired

staticDatasetobjectrequired

Show child parameters

versionstringrequired

notestringrequired

4XX Default Response

Same as 4XX · GET /v1/geo-ips/{ip}

5XX Default Response

Same as 4XX · GET /v1/geo-ips/{ip}

GEThttps://hermeticor.com/v1/benchmarks/campaigns

Peer benchmarks (campaigns): your last 90 days against peer percentiles, falling back to a labelled static reference table

Parameters

industrystringquery

sizestringquery

regionstringquery

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/benchmarks/campaigns" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · GET /v1/benchmarks

4XX Default Response

Same as 4XX · GET /v1/geo-ips/{ip}

5XX Default Response

Same as 4XX · GET /v1/geo-ips/{ip}

Next part

Updated Nov 8, 2026

Was this page helpful?