Skip to Content
API referenceResults

Results

Endpoints

The Results timeline object

Attributes

  • objectstring

    results_timeline

  • brandstring

    The brand the object belongs to (br_…).

  • marketstring

    Market code (ISO country, e.g. FR).

  • periodenum

    Possible values: 30d · 90d · 12m · since

  • started_atstringnullable

    ISO-8601: the end of the brand's first sampling on the market.

  • outcome_kindenum

    Possible values: orders · subscriptions · key_events

  • currencystring
  • selected_eventsarray of stringnullable

    The site's key events (key_events only); null = every named event.

  • categorystring
  • categoriesarray of object
  • googleobject
    Show child attributes
    • statusenum

      Possible values: not_connected · no_property · syncing · ok

  • google_aiobject
    Show child attributes
    • statusenum

      Possible values: not_connected · no_property · no_import · stale · fresh · other_market

    • last_daystringnullable
    • imported_atstringnullable
    • sharenumbernullable
  • direct_on_citedobjectnullable
    Show child attributes
    • sourceenum

      Possible values: script · google_analytics

    • sessionsintegernullable
    • fromstringnullable
    • tostringnullable
    • pagesarray of object
      Show child attributes
      • pathstring
      • sessionsinteger
      • cited_byarray of string
  • ai_reads_pagesarray of objectnullable

    The pages assistants read most to answer someone over the axis; null = the site never forwarded a read.

    Show child attributes
    • pathstring
    • fetchesinteger
    • verifiedinteger
    • errorsinteger
    • not_foundinteger
    • unknown_statusinteger
    • surfacesarray of string
  • weeksarray of object
  • markersarray of object
  • sinceobject
    Show child attributes
    • visibilityobjectnullable
      Show child attributes
      • firstobjectnullable
        Show child attributes
        • week_startstring
        • runsstring
        • hitsstring
        • sharestring
        • by_modelarray of object
      • lastobjectnullable
        Show child attributes
        • week_startstring
        • runsstring
        • hitsstring
        • sharestring
        • by_modelarray of object
      • delta_pointsstring
      • intervalnumbernullable

        95 % half-width of delta_points, in points.

      • interval_contains_zerostring
    • visitsobject
      Show child attributes
      • beforeobjectnullable
        Show child attributes
        • per_weeknumber
        • sourceenumnullable

          Possible values: script · google_analytics · mixed

      • afterobjectnullable
        Show child attributes
        • per_weeknumber
        • sourceenumnullable

          Possible values: script · google_analytics · mixed

    • outcomeobject
      Show child attributes
      • beforeobjectnullable
        Show child attributes
        • per_weeknumber
        • value_per_weeknumbernullable
        • sourcestringnullable
      • afterobjectnullable
        Show child attributes
        • per_weeknumber
        • value_per_weeknumbernullable
        • sourcestringnullable
  • livemodeboolean

    true for live data, false for the test-mode sandbox.

The Results timeline object
{
  "object": "results_timeline",
  "brand": "br_034CyfRFSXUqzrbzV6MAfZ",
  "market": "FR",
  "period": "30d",
  "started_at": "2026-09-21T02:40:00Z",
  "outcome_kind": "orders",
  "currency": "EUR",
  "selected_events": [
    "string"
  ],
  "category": "string",
  "categories": [
    {}
  ],
  "google": {
    "status": "not_connected"
  },
  "google_ai": {
    "status": "not_connected",
    "last_day": "string",
    "imported_at": "2026-09-21T02:40:00Z",
    "share": 27.5
  },
  "direct_on_cited": {
    "source": "script",
    "sessions": 12,
    "from": "string",
    "to": "string",
    "pages": [
      {
        "path": "string",
        "sessions": 12,
        "cited_by": [
          "string"
        ]
      }
    ]
  },
  "ai_reads_pages": [
    {
      "path": "string",
      "fetches": 12,
      "verified": 12,
      "errors": 12,
      "not_found": 12,
      "unknown_status": 12,
      "surfaces": [
        "string"
      ]
    }
  ],
  "weeks": [
    {}
  ],
  "markers": [
    {}
  ],
  "since": {
    "visibility": {
      "first": {
        "week_start": "string",
        "runs": "string",
        "hits": "string",
        "share": "string",
        "by_model": [
          {}
        ]
      },
      "last": {
        "week_start": "string",
        "runs": "string",
        "hits": "string",
        "share": "string",
        "by_model": [
          {}
        ]
      },
      "delta_points": "string",
      "interval": 27.5,
      "interval_contains_zero": "string"
    },
    "visits": {
      "before": {
        "per_week": 27.5,
        "source": "script"
      },
      "after": {
        "per_week": 27.5,
        "source": "script"
      }
    },
    "outcome": {
      "before": {
        "per_week": 27.5,
        "value_per_week": 27.5,
        "source": "string"
      },
      "after": {
        "per_week": 27.5,
        "value_per_week": 27.5,
        "source": "string"
      }
    }
  },
  "livemode": true
}

Retrieve the results timeline

GET/v1/brands/{brand}/results/timeline

Whether Skoup works for the brand, week by week on a market: being seen (AI visibility, raw counts per model), being visited (AI sessions per assistant) and being chosen — AI-attributed orders for an online store, AI subscriptions for a SaaS, the key events of the AI visits otherwise (outcome_kind). Markers put the start of Skoup, the fixes the measure proved, the integrations and the write-backs on the same axis; since compares the first measure with the last and the 4 weeks before the start with the last 4.

One day, one source: each week says who measured it (source), and a week nobody measured is null, never 0. Open to every plan.

Parameters

  • brandstringrequired

    Brand id (br_…).

  • periodstring
  • categorystring

Returns

Returns the results_timeline object. Raises an error if something goes wrong.

curl https://api.skoup.ai/v1/brands/br_034CyfRFSXUqzrbzV6MAfZ/results/timeline \
  -H "Authorization: Bearer skoup_test_4eC39HqLyjWDarjtT1zdp7dc"
Response
{
  "object": "results_timeline",
  "brand": "br_034CyfRFSXUqzrbzV6MAfZ",
  "market": "FR",
  "period": "30d",
  "started_at": "2026-09-21T02:40:00Z",
  "outcome_kind": "orders",
  "currency": "EUR",
  "selected_events": [
    "string"
  ],
  "category": "string",
  "categories": [
    {}
  ],
  "google": {
    "status": "not_connected"
  },
  "google_ai": {
    "status": "not_connected",
    "last_day": "string",
    "imported_at": "2026-09-21T02:40:00Z",
    "share": 27.5
  },
  "direct_on_cited": {
    "source": "script",
    "sessions": 12,
    "from": "string",
    "to": "string",
    "pages": [
      {
        "path": "string",
        "sessions": 12,
        "cited_by": [
          "string"
        ]
      }
    ]
  },
  "ai_reads_pages": [
    {
      "path": "string",
      "fetches": 12,
      "verified": 12,
      "errors": 12,
      "not_found": 12,
      "unknown_status": 12,
      "surfaces": [
        "string"
      ]
    }
  ],
  "weeks": [
    {}
  ],
  "markers": [
    {}
  ],
  "since": {
    "visibility": {
      "first": {
        "week_start": "string",
        "runs": "string",
        "hits": "string",
        "share": "string",
        "by_model": [
          {}
        ]
      },
      "last": {
        "week_start": "string",
        "runs": "string",
        "hits": "string",
        "share": "string",
        "by_model": [
          {}
        ]
      },
      "delta_points": "string",
      "interval": 27.5,
      "interval_contains_zero": "string"
    },
    "visits": {
      "before": {
        "per_week": 27.5,
        "source": "script"
      },
      "after": {
        "per_week": 27.5,
        "source": "script"
      }
    },
    "outcome": {
      "before": {
        "per_week": 27.5,
        "value_per_week": 27.5,
        "source": "string"
      },
      "after": {
        "per_week": 27.5,
        "value_per_week": 27.5,
        "source": "string"
      }
    }
  },
  "livemode": true
}
Last updated on
ReadinessRevenue