Skip to content
Menu
SilktideDevelopers

List the campaigns visitors arrived through

GET/v1/results/analytics/campaigns
View as Markdown

Lists the campaigns visitors arrived through. A campaign is the utm_campaign on the links you share in emails, ads and posts; the same links' utm_source and utm_medium become the visit's source and medium in Get sources. It is the table on the Campaigns screen in Analytics, and takes the Analytics arguments and the table arguments.

Only visits that carried a campaign are counted, so the rows add up to less than every visitor.

Campaign names are recorded exactly as the links spell them. Spring-Sale and spring-sale are two rows, so name campaigns the same way every time.

topSource, topMedium and channel say where most of a campaign's visits came from. They, bounceRate and topEntryUrl cannot be sorted by: a sort naming one of them answers with an error.

Send goalId to see which campaigns lead to a goal, and previousPeriod=1 to compare each row with the period before.

Request
curl "https://api.eu.silktide.com/v1/results/analytics/campaigns?view=all&period=last-90-days&goalId=1&rowsPerPage=2" \
  -H "Authorization: silktide token=$SILKTIDE_API_KEY"
Response: Campaigns over the last 90 days, with completions of a goal
{
  "result": {
    "page": 1,
    "minPage": 1,
    "maxPage": 4,
    "numRows": 7,
    "rowsPerPage": 2,
    "rows": [
      {
        "campaign": "newsletter-october",
        "campaignName": "October newsletter",
        "isLabeled": true,
        "visitors": 30,
        "pageViews": 95,
        "bounceRate": 6,
        "topEntryUrl": "https://fakewinebarrel.com/",
        "topSource": "newsletter",
        "topMedium": "email",
        "topSourceName": "newsletter",
        "topMediumName": "Email",
        "channel": "Email · newsletter",
        "goalCompletions": 1
      },
      {
        "campaign": "autumn-tasting",
        "campaignName": "autumn-tasting",
        "isLabeled": false,
        "visitors": 18,
        "pageViews": 49,
        "bounceRate": 6,
        "topEntryUrl": "https://fakewinebarrel.com/events/",
        "topSource": "Google",
        "topMedium": "search",
        "topSourceName": "Google",
        "topMediumName": "Search",
        "channel": "Search · Google",
        "goalCompletions": 0
      }
    ]
  },
  "selector": "/v1/results/analytics/campaigns",
  "duration": 0.12
}

Request

Query parameters

  • viewstringmatches ^(all|[1-9]\d*)$

    The analytics view to read: its id, the number after /analytics/ in its address in Silktide, or all for all of the account's analytics. Send this or websiteId.

  • websiteIdintegerat least 1

    Instead of view, a website whose analytics to read. The website must have Analytics set up.

  • sectionIdinteger

    With websiteId, a section of the website. Defaults to 0, the whole website.

  • periodstring

    The date range. Defaults to all. The spaced forms (-7 days, month to date) are older names that keep working. custom needs from and to.

    One ofalltodaylast-7-dayslast-30-dayslast-90-daysmonth-to-datelast-monthyear-to-datelast-12-monthscustom-7 days-30 days-90 days-1 monthmonth to dateyear to date-12 months

  • fromstring

    With period=custom, the first day, such as 2026-10-01.

  • tostring

    With period=custom, the last day.

  • timezonestring

    The IANA time zone days are read in, such as America/New_York. Defaults to UTC.

  • filtersmap of strings

    Only visits matching every filter, keyed by what is filtered: filters[url]=contains:/blog. Each value is {operator}:{value}, with operator is, not, contains, starts, gt or lt. Keys include url, hostName, entryUrl, exitUrl, event, outgoingUrl, referrer, source, medium, campaign, content, term, countryCode, regionCode, language, deviceType (desktop, tablet or mobile), operatingSystem and browser.

  • columnsstring

    The columns to return, comma-separated, such as url,pageViews. Left out, the table's default columns. Send a string even in a JSON body: an array is ignored.

  • sortstring

    The column to sort by, then :a for ascending or :d for descending, such as pageViews:d. Left out, the table's own order.

  • searchstring

    Only rows matching this text. What it searches depends on the table, most often the URL or title.

  • pageintegerat least 1

    The page of rows to return, from 1. Defaults to 1.

  • rowsPerPageintegerat least 1

    How many rows a page holds. Defaults to 100.

  • goalIdintegerat least 1

    A goal, by the goalId Get goals gives it. Adds goalCompletions to every row. Left out, no goal.

  • previousPeriodstring

    1 to add the figures of the period before, the same length and ending where this one starts, as previous… fields. Left out or 0, none. Needs a period with a start: with all, nothing is added.

    One of01

Response

200JSON.

  • resultobjectrequired

    The answer.

    Show 6 fields
    • pageintegerrequiredat least 1

      The page returned. Not always the page asked for, when that was out of range.

    • minPageintegerrequiredat least 1

      The first page. Always 1.

    • maxPageintegerrequired

      The last page at this rowsPerPage. With no rows, 0 or 1 depending on the table.

    • numRowsintegerrequired

      How many rows there are across every page.

    • rowsPerPageintegerrequiredat least 1

      How many rows a page holds.

    • rowslist of objectsrequired

      The rows on this page.

      Show 15 fields
      • campaignstringrequired

        The campaign as recorded: the utm_campaign of the links visitors arrived by. Filter by it with filters[campaign].

      • campaignNamestringrequired

        The campaign's name, as Silktide shows it: the account's label for it where one is set, otherwise campaign.

      • isLabeledbooleanrequired

        Whether campaignName is a label the account gave this campaign.

      • visitorsintegerrequired

        Unique visitors who arrived through it.

      • pageViewsintegerrequired

        Pages those visitors viewed.

      • bounceRateintegerrequiredcan be null0 to 100

        The share of its visits that viewed one page and left, as a whole percentage. Null when none of its visits started in the period.

      • topEntryUrlstringrequired

        The page its visits most often began on. Empty when none of its visits started in the period.

      • topSourcestringrequired

        The source most of its visits came from, as recorded, the same value as source in Get sources. Empty for direct visits, or when none of its visits started in the period.

      • topMediumstringrequired

        The medium most of its visits came through, as recorded, the same value as medium in Get sources. Empty as topSource is.

      • topSourceNamestringrequired

        topSource as Silktide names it, such as Google, or Direct. Empty when none of its visits started in the period.

      • topMediumNamestringrequired

        topMedium as Silktide names it, such as Search or Email. Empty when none of its visits started in the period.

      • channelstringrequired

        The medium and source together, as one label: Search · Google, or only the medium, such as Direct, when the visits carried no source. Empty when none of its visits started in the period.

      • goalCompletionsinteger

        How many times its visitors completed the goal. Only with goalId.

      • previousVisitorsinteger

        Unique visitors in the period before. Only with previousPeriod=1 and a period other than all. 0 when it had none then.

      • previousPageViewsinteger

        Page views in the period before. Only with previousPeriod=1 and a period other than all. 0 when it had none then.

  • selectorstringrequired

    The query that answered, as its path: /v1/results/scores.

  • durationnumberrequired

    Seconds Silktide took to answer.

Errors

StatusTypeWhen
404ModelNotFoundNo view or website with that id exists in the account, or the API key's user cannot see it.
403AccessDeniedThe API key's user cannot read that analytics view.
200ModelNotFoundThe website has no Analytics set up. The body is an error despite the status.
200InvalidRequestNeither view nor websiteId was sent. The error's own status is 400 and properties.field is view. The body is an error despite the status.
200InvalidArgumentA filter names a key or operator Analytics does not know. The body is an error despite the status.
200InvalidArgumentperiod is not one of its values, or is custom without both from and to. The body is an error despite the status.
404ModelNotFoundgoalId names no goal of the view.
200-sort names a column the table cannot sort by. Sort by campaignName, visitors, pageViews or goalCompletions only. The body is an error despite the status.
401NotLoggedInNo API key was sent, or it is not a key for this region.(any operation)
429TooManyRequestsToo many requests to this path in five seconds. Retry after the number of seconds in the Retry-After header, which properties.retryAfter repeats.(any operation)
503-Silktide is busy. Retry after the number of seconds in the Retry-After header.(any operation)

Every error has the same body. See Errors.

Access

Permission
View analytics view (View all analytics for `view=all`)
Plan feature
None
Edition
Silktide 4 and Silktide 5
Cost
Free
Available since
v1.0.0

Try it

Sends a real request to your account from this browser. Your key stays in this tab and goes only to the Silktide API.